Interface IQueryService

Represents a collection of functions to interact with the API endpoints

Namespace: InfluxDB.Client.Api.Service

Assembly: InfluxDB.Client.dll

Syntax

public interface IQueryService : IApiAccessor

Methods

GetQuerySuggestions(String)

Retrieve query suggestions

Declaration

FluxSuggestions GetQuerySuggestions(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
FluxSuggestions	FluxSuggestions

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsAsync(String, CancellationToken)

Retrieve query suggestions

Declaration

System.Threading.Tasks.Task<FluxSuggestions> GetQuerySuggestionsAsync(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<FluxSuggestions>	Task of FluxSuggestions

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsAsyncWithHttpInfo(String, CancellationToken)

Retrieve query suggestions

Declaration

System.Threading.Tasks.Task<ApiResponse<FluxSuggestions>> GetQuerySuggestionsAsyncWithHttpInfo(string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestions>>	Task of ApiResponse (FluxSuggestions)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsName(String, String)

Retrieve query suggestions for a branching suggestion

Declaration

FluxSuggestion GetQuerySuggestionsName(string name, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	name	The name of the branching suggestion.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
FluxSuggestion	FluxSuggestion

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsNameAsync(String, String, CancellationToken)

Retrieve query suggestions for a branching suggestion

Declaration

System.Threading.Tasks.Task<FluxSuggestion> GetQuerySuggestionsNameAsync(string name, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	The name of the branching suggestion.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<FluxSuggestion>	Task of FluxSuggestion

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsNameAsyncWithHttpInfo(String, String, CancellationToken)

Retrieve query suggestions for a branching suggestion

Declaration

System.Threading.Tasks.Task<ApiResponse<FluxSuggestion>> GetQuerySuggestionsNameAsyncWithHttpInfo(string name, string zapTraceSpan = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	name	The name of the branching suggestion.
System.String	zapTraceSpan	OpenTracing span context (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestion>>	Task of ApiResponse (FluxSuggestion)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsNameWithHttpInfo(String, String)

Retrieve query suggestions for a branching suggestion

Declaration

ApiResponse<FluxSuggestion> GetQuerySuggestionsNameWithHttpInfo(string name, string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	name	The name of the branching suggestion.
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestion>	ApiResponse of FluxSuggestion

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

GetQuerySuggestionsWithHttpInfo(String)

Retrieve query suggestions

Declaration

ApiResponse<FluxSuggestions> GetQuerySuggestionsWithHttpInfo(string zapTraceSpan = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<FluxSuggestions>	ApiResponse of FluxSuggestions

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQuery(String, String, String, String, String, Query)

Query data

Declaration

string PostQuery(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.String	contentType	(optional)
System.String	org	Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)
System.String	orgID	Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)
Query	query	Flux query or specification to execute (optional)

Returns

Type	Description
System.String	string

Remarks

Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAnalyze(String, String, Query)

Analyze a Flux query

Declaration

AnalyzeQueryResponse PostQueryAnalyze(string zapTraceSpan = null, string contentType = null, Query query = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
Query	query	Flux query to analyze (optional)

Returns

Type	Description
AnalyzeQueryResponse	AnalyzeQueryResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAnalyzeAsync(String, String, Query, CancellationToken)

Analyze a Flux query

Declaration

System.Threading.Tasks.Task<AnalyzeQueryResponse> PostQueryAnalyzeAsync(string zapTraceSpan = null, string contentType = null, Query query = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
Query	query	Flux query to analyze (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<AnalyzeQueryResponse>	Task of AnalyzeQueryResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAnalyzeAsyncWithHttpInfo(String, String, Query, CancellationToken)

Analyze a Flux query

Declaration

System.Threading.Tasks.Task<ApiResponse<AnalyzeQueryResponse>> PostQueryAnalyzeAsyncWithHttpInfo(string zapTraceSpan = null, string contentType = null, Query query = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
Query	query	Flux query to analyze (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<AnalyzeQueryResponse>>	Task of ApiResponse (AnalyzeQueryResponse)

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAnalyzeWithHttpInfo(String, String, Query)

Analyze a Flux query

Declaration

ApiResponse<AnalyzeQueryResponse> PostQueryAnalyzeWithHttpInfo(string zapTraceSpan = null, string contentType = null, Query query = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
Query	query	Flux query to analyze (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<AnalyzeQueryResponse>	ApiResponse of AnalyzeQueryResponse

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAst(String, String, LanguageRequest)

Generate an Abstract Syntax Tree (AST) from a query

Declaration

ASTResponse PostQueryAst(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
LanguageRequest	languageRequest	Analyzed Flux query to generate abstract syntax tree. (optional)

Returns

Type	Description
ASTResponse	ASTResponse

Remarks

Analyzes flux query and generates a query specification.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAstAsync(String, String, LanguageRequest, CancellationToken)

Generate an Abstract Syntax Tree (AST) from a query

Declaration

System.Threading.Tasks.Task<ASTResponse> PostQueryAstAsync(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
LanguageRequest	languageRequest	Analyzed Flux query to generate abstract syntax tree. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<ASTResponse>	Task of ASTResponse

Remarks

Analyzes flux query and generates a query specification.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAstAsyncWithHttpInfo(String, String, LanguageRequest, CancellationToken)

Generate an Abstract Syntax Tree (AST) from a query

Declaration

System.Threading.Tasks.Task<ApiResponse<ASTResponse>> PostQueryAstAsyncWithHttpInfo(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
LanguageRequest	languageRequest	Analyzed Flux query to generate abstract syntax tree. (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<ASTResponse>>	Task of ApiResponse (ASTResponse)

Remarks

Analyzes flux query and generates a query specification.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAstWithHttpInfo(String, String, LanguageRequest)

Generate an Abstract Syntax Tree (AST) from a query

Declaration

ApiResponse<ASTResponse> PostQueryAstWithHttpInfo(string zapTraceSpan = null, string contentType = null, LanguageRequest languageRequest = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	contentType	(optional)
LanguageRequest	languageRequest	Analyzed Flux query to generate abstract syntax tree. (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<ASTResponse>	ApiResponse of ASTResponse

Remarks

Analyzes flux query and generates a query specification.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAsync(String, String, String, String, String, Query, CancellationToken)

Query data

Declaration

System.Threading.Tasks.Task<string> PostQueryAsync(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.String	contentType	(optional)
System.String	org	Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)
System.String	orgID	Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)
Query	query	Flux query or specification to execute (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<System.String>	Task of string

Remarks

Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryAsyncWithHttpInfo(String, String, String, String, String, Query, CancellationToken)

Query data

Declaration

System.Threading.Tasks.Task<ApiResponse<string>> PostQueryAsyncWithHttpInfo(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null, CancellationToken cancellationToken = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.String	contentType	(optional)
System.String	org	Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)
System.String	orgID	Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)
Query	query	Flux query or specification to execute (optional)
CancellationToken	cancellationToken	Cancellation token

Returns

Type	Description
System.Threading.Tasks.Task<InfluxDB.Client.Api.Client.ApiResponse<System.String>>	Task of ApiResponse (string)

Remarks

Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call

PostQueryWithHttpInfo(String, String, String, String, String, Query)

Query data

Declaration

ApiResponse<string> PostQueryWithHttpInfo(string zapTraceSpan = null, string acceptEncoding = null, string contentType = null, string org = null, string orgID = null, Query query = null)

Parameters

Type	Name	Description
System.String	zapTraceSpan	OpenTracing span context (optional)
System.String	acceptEncoding	Indicates the content encoding (usually a compression algorithm) that the client can understand. (optional, default to identity)
System.String	contentType	(optional)
System.String	org	Specifies the name of the organization executing the query. Takes either the ID or Name. If both orgID and org are specified, org takes precedence. (optional)
System.String	orgID	Specifies the ID of the organization executing the query. If both orgID and org are specified, org takes precedence. (optional)
Query	query	Flux query or specification to execute (optional)

Returns

Type	Description
InfluxDB.Client.Api.Client.ApiResponse<System.String>	ApiResponse of string

Remarks

Retrieves data from InfluxDB buckets. To query data, you need the following: - organization – See View organizations for instructions on viewing your organization ID. - API token – See View tokens for instructions on viewing your API token. - InfluxDB URL – See InfluxDB URLs. - Flux query – See Flux. For more information and examples, see Query with the InfluxDB API.

Exceptions

Type	Condition
InfluxDB.Client.Api.Client.ApiException	Thrown when fails to make API call