Class QueryAPI

Query API

Index

Constructors

Methods

getQuerySuggestions getQuerySuggestionsName postQuery postQueryAnalyze postQueryAst

Constructors

constructor

new QueryAPI(influxDB: InfluxDB): QueryAPI
Creates QueryAPI
Parameters
- influxDB: InfluxDB
  an instance that knows how to communicate with InfluxDB server
Returns QueryAPI
- Defined in apis/src/generated/QueryAPI.ts:66

Methods

getQuerySuggestions

getQuerySuggestions(
request?: GetQuerySuggestionsRequest,
requestOptions?: RequestOptions,
): Promise<FluxSuggestions>
Retrieve Flux query suggestions. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetQuerySuggestions
Parameters
- Optionalrequest: GetQuerySuggestionsRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<FluxSuggestions>
promise of response
- Defined in apis/src/generated/QueryAPI.ts:95

getQuerySuggestionsName

getQuerySuggestionsName(
request: GetQuerySuggestionsNameRequest,
requestOptions?: RequestOptions,
): Promise<FluxSuggestion>
Retrieve a query suggestion for a branching suggestion. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/GetQuerySuggestionsName
Parameters
- request: GetQuerySuggestionsNameRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<FluxSuggestion>
promise of response
- Defined in apis/src/generated/QueryAPI.ts:113

postQuery

postQuery(
request: PostQueryRequest,
requestOptions?: RequestOptions,
): Promise<string>
Query data. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostQuery
Parameters
- request: PostQueryRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<string>
promise of response
- Defined in apis/src/generated/QueryAPI.ts:150

postQueryAnalyze

postQueryAnalyze(
request: PostQueryAnalyzeRequest,
requestOptions?: RequestOptions,
): Promise<AnalyzeQueryResponse>
Analyze a Flux query. See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostQueryAnalyze
Parameters
- request: PostQueryAnalyzeRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<AnalyzeQueryResponse>
promise of response
- Defined in apis/src/generated/QueryAPI.ts:131

postQueryAst

postQueryAst(
request: PostQueryAstRequest,
requestOptions?: RequestOptions,
): Promise<ASTResponse>
Generate a query Abstract Syntax Tree (AST). See https://docs.influxdata.com/influxdb/v2.4/api/#operation/PostQueryAst
Parameters
- request: PostQueryAstRequest
  request parameters and body (if supported)
- OptionalrequestOptions: RequestOptions
  optional transport options
Returns Promise<ASTResponse>
promise of response
- Defined in apis/src/generated/QueryAPI.ts:76