InfluxDB PHP Client
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
InfluxDB2\Service\QueryService Class Reference

Public Member Functions

 __construct (DefaultApi $defaultApi)
 
 getQuerySuggestions ($zap_trace_span=null)
 
 getQuerySuggestionsWithHttpInfo ($zap_trace_span=null)
 
 getQuerySuggestionsName ($name, $zap_trace_span=null)
 
 getQuerySuggestionsNameWithHttpInfo ($name, $zap_trace_span=null)
 
 postQuery ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $query=null)
 
 postQueryWithHttpInfo ($zap_trace_span=null, $accept_encoding='identity', $content_type=null, $org=null, $org_id=null, $query=null)
 
 postQueryAnalyze ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAnalyzeWithHttpInfo ($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)
 

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, $query=null)
 
 postQueryAnalyzeRequest ($zap_trace_span=null, $content_type=null, $query=null)
 
 postQueryAstRequest ($zap_trace_span=null, $content_type=null, $language_request=null)
 

Protected Attributes

 $defaultApi
 
 $headerSelector
 

Constructor & Destructor Documentation

◆ __construct()

InfluxDB2\Service\QueryService::__construct ( DefaultApi $defaultApi)
Parameters
DefaultApi$defaultApi
HeaderSelector$selector

Member Function Documentation

◆ getQuerySuggestions()

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

Operation getQuerySuggestions

Retrieve Flux query suggestions

Parameters
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getQuerySuggestionsName()

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

Operation getQuerySuggestionsName

Retrieve a query suggestion for a branching suggestion

Parameters
string$nameA Flux Function name. Only returns functions with this name. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ getQuerySuggestionsNameRequest()

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

Create request for operation 'getQuerySuggestionsName'

Parameters
string$nameA Flux Function name. Only returns functions with this name. (required)
string$zap_trace_spanOpenTracing span context (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ getQuerySuggestionsNameWithHttpInfo()

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

Operation getQuerySuggestionsNameWithHttpInfo

Retrieve a query suggestion for a branching suggestion

Parameters
string$nameA Flux Function name. Only returns functions with this name. (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
\Psr\Http\Message\RequestInterface

◆ getQuerySuggestionsWithHttpInfo()

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

Operation getQuerySuggestionsWithHttpInfo

Retrieve Flux 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|object|\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,
$query = null )

Operation postQuery

Query data

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')
string$content_typecontent_type (optional)
string$orgThe name or ID of the organization executing the query. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Queries the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string$org_idThe ID of the organization executing the query. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Queries the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
\InfluxDB2\Model\Query$queryFlux query or specification to execute (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
string|\InfluxDB2\Model\Error|object|\InfluxDB2\Model\Error|\InfluxDB2\Model\Error|string

◆ postQueryAnalyze()

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

Operation postQueryAnalyze

Analyze a Flux query

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ 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 query to analyze (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postQueryAnalyzeWithHttpInfo()

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

Operation postQueryAnalyzeWithHttpInfo

Analyze a Flux query

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

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

Returns
array of \InfluxDB2\Model\AnalyzeQueryResponse|\InfluxDB2\Model\Error|\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 a query Abstract Syntax Tree (AST)

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_typecontent_type (optional)
\InfluxDB2\Model\LanguageRequest$language_requestThe Flux query to analyze. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ 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_requestThe Flux query to analyze. (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postQueryAstWithHttpInfo()

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

Operation postQueryAstWithHttpInfo

Generate a query Abstract Syntax Tree (AST)

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$content_type(optional)
\InfluxDB2\Model\LanguageRequest$language_requestThe Flux query to analyze. (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

◆ postQueryRequest()

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

Create request for operation 'postQuery'

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')
string$content_type(optional)
string$orgThe name or ID of the organization executing the query. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Queries the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string$org_idThe ID of the organization executing the query. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Queries the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
\InfluxDB2\Model\Query$queryFlux query or specification to execute (optional)
Exceptions

InvalidArgumentException

Returns
\Psr\Http\Message\RequestInterface

◆ postQueryWithHttpInfo()

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

Operation postQueryWithHttpInfo

Query data

Parameters
string$zap_trace_spanOpenTracing span context (optional)
string$accept_encodingThe content encoding (usually a compression algorithm) that the client can understand. (optional, default to 'identity')
string$content_type(optional)
string$orgThe name or ID of the organization executing the query. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Queries the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
string$org_idThe ID of the organization executing the query. #### InfluxDB Cloud - Doesn't use `org` or `orgID`. - Queries the bucket in the organization associated with the authorization (API token). #### InfluxDB OSS - Requires either `org` or `orgID`. (optional)
\InfluxDB2\Model\Query$queryFlux query or specification to execute (optional)
Exceptions

InfluxDB2\ApiException on non-2xx response

Exceptions

InvalidArgumentException

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

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