• InfluxDB.Client API
Show / Hide Table of Contents
  • InfluxDB.Client
    • AuthorizationsApi
    • BucketsApi
    • ChecksApi
    • DeleteApi
    • IAuthorizationsApi
    • IBucketsApi
    • IChecksApi
    • IDeleteApi
    • IDomainObjectMapper
    • IInfluxDBClient
    • IInvokableScriptsApi
    • ILabelsApi
    • InfluxDBClient
    • InfluxDBClientFactory
    • InfluxDBClientOptions
    • InfluxDBClientOptions.AuthenticationScheme
    • InfluxDBClientOptions.Builder
    • INotificationEndpointsApi
    • INotificationRulesApi
    • InvokableScriptsApi
    • IOrganizationsApi
    • IQueryApi
    • IQueryApiSync
    • IScraperTargetsApi
    • ISourcesApi
    • ITasksApi
    • ITelegrafsApi
    • IUsersApi
    • IWriteApi
    • IWriteApiAsync
    • LabelsApi
    • NotificationEndpointsApi
    • NotificationRulesApi
    • OrganizationsApi
    • QueryApi
    • QueryApiSync
    • ScraperTargetsApi
    • SourcesApi
    • TasksApi
    • TelegrafsApi
    • UsersApi
    • WriteApi
    • WriteApiAsync
    • WriteOptions
    • WriteOptions.Builder
  • InfluxDB.Client.Api.Domain
    • AddResourceMemberRequestBody
    • AnalyzeQueryResponse
    • AnalyzeQueryResponseErrors
    • ArrayExpression
    • ArrayExpression.ArrayExpressionElementsAdapter
    • ASTResponse
    • Authorization
    • AuthorizationLinks
    • AuthorizationPostRequest
    • Authorizations
    • AuthorizationUpdateRequest
    • AuthorizationUpdateRequest.StatusEnum
    • Axes
    • Axis
    • Axis.BaseEnum
    • AxisScale
    • BadStatement
    • BandViewProperties
    • BandViewProperties.HoverDimensionEnum
    • BandViewProperties.ShapeEnum
    • BandViewProperties.TypeEnum
    • BinaryExpression
    • BinaryExpression.BinaryExpressionLeftAdapter
    • BinaryExpression.BinaryExpressionRightAdapter
    • Block
    • Block.BlockBodyAdapter
    • BooleanLiteral
    • Bucket
    • Bucket.TypeEnum
    • BucketLinks
    • BucketMetadataManifest
    • BucketRetentionRules
    • BucketRetentionRules.TypeEnum
    • Buckets
    • BucketShardMapping
    • BuilderAggregateFunctionType
    • BuilderConfig
    • BuilderConfigAggregateWindow
    • BuilderFunctionsType
    • BuilderTagsType
    • BuiltinStatement
    • CallExpression
    • CallExpression.CallExpressionArgumentsAdapter
    • CallExpression.CallExpressionCalleeAdapter
    • Cell
    • CellLinks
    • CellUpdate
    • CellWithViewProperties
    • Check
    • CheckBase
    • CheckBase.LastRunStatusEnum
    • CheckBaseLinks
    • CheckDiscriminator
    • CheckPatch
    • CheckPatch.StatusEnum
    • Checks
    • CheckStatusLevel
    • CheckViewProperties
    • CheckViewProperties.ShapeEnum
    • CheckViewProperties.TypeEnum
    • ConditionalExpression
    • ConditionalExpression.ConditionalExpressionAlternateAdapter
    • ConditionalExpression.ConditionalExpressionConsequentAdapter
    • ConditionalExpression.ConditionalExpressionTestAdapter
    • Config
    • ConstantVariableProperties
    • ConstantVariableProperties.TypeEnum
    • CreateCell
    • CreateDashboardRequest
    • CustomCheck
    • CustomCheck.TypeEnum
    • Dashboard
    • DashboardColor
    • DashboardColor.TypeEnum
    • DashboardLinks
    • DashboardMeta
    • DashboardQuery
    • Dashboards
    • DashboardWithViewProperties
    • DateTimeLiteral
    • DBRP
    • DBRPCreate
    • DBRPGet
    • DBRPs
    • DBRPUpdate
    • DeadmanCheck
    • DeadmanCheck.TypeEnum
    • DecimalPlaces
    • DeletePredicateRequest
    • Dialect
    • Dialect.AnnotationsEnum
    • Dialect.DateTimeFormatEnum
    • DictExpression
    • DictItem
    • DictItem.DictItemKeyAdapter
    • DictItem.DictItemValAdapter
    • Duration
    • DurationLiteral
    • Error
    • Error.CodeEnum
    • Expression
    • ExpressionStatement
    • ExpressionStatement.ExpressionStatementExpressionAdapter
    • Field
    • Field.TypeEnum
    • File
    • File.FileBodyAdapter
    • FloatLiteral
    • FluxResponse
    • FluxSuggestion
    • FluxSuggestions
    • FunctionExpression
    • FunctionExpression.FunctionExpressionBodyAdapter
    • GaugeViewProperties
    • GaugeViewProperties.ShapeEnum
    • GaugeViewProperties.TypeEnum
    • GreaterThreshold
    • GreaterThreshold.TypeEnum
    • HealthCheck
    • HealthCheck.StatusEnum
    • HeatmapViewProperties
    • HeatmapViewProperties.ShapeEnum
    • HeatmapViewProperties.TypeEnum
    • HistogramViewProperties
    • HistogramViewProperties.PositionEnum
    • HistogramViewProperties.ShapeEnum
    • HistogramViewProperties.TypeEnum
    • HTTPNotificationEndpoint
    • HTTPNotificationEndpoint.AuthMethodEnum
    • HTTPNotificationEndpoint.MethodEnum
    • HTTPNotificationRule
    • HTTPNotificationRuleBase
    • HTTPNotificationRuleBase.TypeEnum
    • Identifier
    • ImportDeclaration
    • IndexExpression
    • IndexExpression.IndexExpressionArrayAdapter
    • IndexExpression.IndexExpressionIndexAdapter
    • IntegerLiteral
    • IsOnboarding
    • Label
    • LabelCreateRequest
    • LabelMapping
    • LabelResponse
    • LabelsResponse
    • LabelUpdate
    • LanguageRequest
    • LegacyAuthorizationPostRequest
    • LesserThreshold
    • LesserThreshold.TypeEnum
    • LinePlusSingleStatProperties
    • LinePlusSingleStatProperties.HoverDimensionEnum
    • LinePlusSingleStatProperties.PositionEnum
    • LinePlusSingleStatProperties.ShapeEnum
    • LinePlusSingleStatProperties.TypeEnum
    • LineProtocolError
    • LineProtocolError.CodeEnum
    • LineProtocolLengthError
    • LineProtocolLengthError.CodeEnum
    • Links
    • ListStacksResponse
    • LogEvent
    • LogicalExpression
    • LogicalExpression.LogicalExpressionLeftAdapter
    • LogicalExpression.LogicalExpressionRightAdapter
    • Logs
    • MapVariableProperties
    • MapVariableProperties.TypeEnum
    • MarkdownViewProperties
    • MarkdownViewProperties.ShapeEnum
    • MarkdownViewProperties.TypeEnum
    • MemberAssignment
    • MemberAssignment.MemberAssignmentInitAdapter
    • MemberExpression
    • MemberExpression.MemberExpressionObjectAdapter
    • MemberExpression.MemberExpressionPropertyAdapter
    • MetadataBackup
    • MosaicViewProperties
    • MosaicViewProperties.HoverDimensionEnum
    • MosaicViewProperties.ShapeEnum
    • MosaicViewProperties.TypeEnum
    • Node
    • NotificationEndpoint
    • NotificationEndpointBase
    • NotificationEndpointBase.StatusEnum
    • NotificationEndpointBaseLinks
    • NotificationEndpointDiscriminator
    • NotificationEndpoints
    • NotificationEndpointType
    • NotificationEndpointUpdate
    • NotificationEndpointUpdate.StatusEnum
    • NotificationRule
    • NotificationRuleBase
    • NotificationRuleBase.LastRunStatusEnum
    • NotificationRuleBaseLinks
    • NotificationRuleDiscriminator
    • NotificationRules
    • NotificationRuleUpdate
    • NotificationRuleUpdate.StatusEnum
    • ObjectExpression
    • OnboardingRequest
    • OnboardingResponse
    • OptionStatement
    • OptionStatement.OptionStatementAssignmentAdapter
    • Organization
    • Organization.StatusEnum
    • OrganizationLinks
    • Organizations
    • Package
    • PackageClause
    • PagerDutyNotificationEndpoint
    • PagerDutyNotificationRule
    • PagerDutyNotificationRuleBase
    • PagerDutyNotificationRuleBase.TypeEnum
    • ParenExpression
    • ParenExpression.ParenExpressionExpressionAdapter
    • PasswordResetBody
    • PatchBucketRequest
    • PatchDashboardRequest
    • PatchOrganizationRequest
    • PatchRetentionRule
    • PatchRetentionRule.TypeEnum
    • PatchStackRequest
    • PatchStackRequestAdditionalResources
    • Permission
    • Permission.ActionEnum
    • PermissionResource
    • PipeExpression
    • PipeExpression.PipeExpressionArgumentAdapter
    • PipeLiteral
    • PostBucketRequest
    • PostOrganizationRequest
    • PostRestoreKVResponse
    • PostStackRequest
    • PostUser
    • PostUser.StatusEnum
    • Property
    • Property.PropertyKeyAdapter
    • Property.PropertyValueAdapter
    • PropertyKey
    • Query
    • Query.TypeEnum
    • QueryEditMode
    • QueryVariableProperties
    • QueryVariableProperties.TypeEnum
    • QueryVariablePropertiesValues
    • RangeThreshold
    • RangeThreshold.TypeEnum
    • Ready
    • Ready.StatusEnum
    • RegexpLiteral
    • RemoteConnection
    • RemoteConnectionCreationRequest
    • RemoteConnections
    • RemoteConnectionUpdateRequest
    • RenamableField
    • Replication
    • ReplicationCreationRequest
    • Replications
    • ReplicationUpdateRequest
    • ResourceMember
    • ResourceMember.RoleEnum
    • ResourceMembers
    • ResourceOwner
    • ResourceOwner.RoleEnum
    • ResourceOwners
    • RestoredBucketMappings
    • RetentionPolicyManifest
    • ReturnStatement
    • ReturnStatement.ReturnStatementArgumentAdapter
    • Routes
    • RoutesExternal
    • RoutesQuery
    • RoutesSystem
    • RuleStatusLevel
    • Run
    • Run.StatusEnum
    • RunLinks
    • RunManually
    • Runs
    • ScatterViewProperties
    • ScatterViewProperties.ShapeEnum
    • ScatterViewProperties.TypeEnum
    • SchemaType
    • ScraperTargetRequest
    • ScraperTargetRequest.TypeEnum
    • ScraperTargetResponse
    • ScraperTargetResponseLinks
    • ScraperTargetResponses
    • Script
    • ScriptCreateRequest
    • ScriptInvocationParams
    • ScriptLanguage
    • Scripts
    • ScriptUpdateRequest
    • SecretKeys
    • SecretKeysResponse
    • SecretKeysResponseLinks
    • ShardGroupManifest
    • ShardManifest
    • ShardOwner
    • SimpleTableViewProperties
    • SimpleTableViewProperties.ShapeEnum
    • SimpleTableViewProperties.TypeEnum
    • SingleStatViewProperties
    • SingleStatViewProperties.ShapeEnum
    • SingleStatViewProperties.TypeEnum
    • SlackNotificationEndpoint
    • SlackNotificationRule
    • SlackNotificationRuleBase
    • SlackNotificationRuleBase.TypeEnum
    • SMTPNotificationRule
    • SMTPNotificationRuleBase
    • SMTPNotificationRuleBase.TypeEnum
    • Source
    • Source.LanguagesEnum
    • Source.TypeEnum
    • SourceLinks
    • Sources
    • Stack
    • StackAssociations
    • StackEvents
    • StackLinks
    • StackResources
    • Statement
    • StaticLegend
    • StatusRule
    • StringLiteral
    • SubscriptionManifest
    • TableViewProperties
    • TableViewProperties.ShapeEnum
    • TableViewProperties.TypeEnum
    • TableViewPropertiesTableOptions
    • TableViewPropertiesTableOptions.WrappingEnum
    • TagRule
    • TagRule.OperatorEnum
    • TaskCreateRequest
    • TaskLinks
    • Tasks
    • TaskStatusType
    • TaskType
    • TaskType.LastRunStatusEnum
    • TaskUpdateRequest
    • Telegraf
    • TelegrafLinks
    • TelegrafPlugin
    • TelegrafPlugin.TypeEnum
    • TelegrafPluginRequest
    • TelegrafPluginRequestPlugins
    • TelegrafPlugins
    • TelegrafRequest
    • TelegrafRequestMetadata
    • Telegrafs
    • TelegramNotificationEndpoint
    • TelegramNotificationRule
    • TelegramNotificationRuleBase
    • TelegramNotificationRuleBase.ParseModeEnum
    • TelegramNotificationRuleBase.TypeEnum
    • TemplateApply
    • TemplateApplyRemotes
    • TemplateApplyTemplate
    • TemplateChart
    • TemplateChart.TemplateChartPropertiesAdapter
    • TemplateExportByID
    • TemplateExportByIDOrgIDs
    • TemplateExportByIDResourceFilters
    • TemplateExportByIDResources
    • TemplateKind
    • TemplateSummary
    • TemplateSummaryDiff
    • TemplateSummaryDiffBuckets
    • TemplateSummaryDiffBucketsNewOld
    • TemplateSummaryDiffChecks
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksNewAdapter
    • TemplateSummaryDiffChecks.TemplateSummary_diff_checksOldAdapter
    • TemplateSummaryDiffDashboards
    • TemplateSummaryDiffDashboardsNewOld
    • TemplateSummaryDiffLabelMappings
    • TemplateSummaryDiffLabels
    • TemplateSummaryDiffLabelsNewOld
    • TemplateSummaryDiffNotificationEndpoints
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsNewAdapter
    • TemplateSummaryDiffNotificationEndpoints.TemplateSummary_diff_notificationEndpointsOldAdapter
    • TemplateSummaryDiffNotificationRules
    • TemplateSummaryDiffNotificationRulesNewOld
    • TemplateSummaryDiffTasks
    • TemplateSummaryDiffTasksNewOld
    • TemplateSummaryDiffTelegrafConfigs
    • TemplateSummaryDiffVariables
    • TemplateSummaryDiffVariablesNewOld
    • TemplateSummaryDiffVariablesNewOld.TemplateSummary_Diff_variables_new_oldArgsAdapter
    • TemplateSummaryErrors
    • TemplateSummaryLabel
    • TemplateSummaryLabelProperties
    • TemplateSummarySummary
    • TemplateSummarySummaryBuckets
    • TemplateSummarySummaryDashboards
    • TemplateSummarySummaryLabelMappings
    • TemplateSummarySummaryNotificationRules
    • TemplateSummarySummaryStatusRules
    • TemplateSummarySummaryTagRules
    • TemplateSummarySummaryTasks
    • TemplateSummarySummaryVariables
    • TemplateSummarySummaryVariables.TemplateSummary_summary_variablesArgumentsAdapter
    • TestStatement
    • Threshold
    • ThresholdBase
    • ThresholdCheck
    • ThresholdCheck.TypeEnum
    • ThresholdCheckTags
    • UnaryExpression
    • UnaryExpression.UnaryExpressionArgumentAdapter
    • UnsignedIntegerLiteral
    • User
    • User.StatusEnum
    • UserLinks
    • Users
    • UsersLinks
    • Variable
    • Variable.VariableArgumentsAdapter
    • VariableAssignment
    • VariableAssignment.VariableAssignmentInitAdapter
    • VariableLinks
    • VariableProperties
    • Variables
    • View
    • View.ViewPropertiesAdapter
    • ViewLinks
    • ViewProperties
    • Views
    • WritePrecision
    • XYGeom
    • XYViewProperties
    • XYViewProperties.HoverDimensionEnum
    • XYViewProperties.PositionEnum
    • XYViewProperties.ShapeEnum
    • XYViewProperties.TypeEnum
  • InfluxDB.Client.Api.Service
    • AuthorizationsService
    • BackupService
    • BucketsService
    • CellsService
    • ChecksService
    • ConfigService
    • DashboardsService
    • DBRPsService
    • DeleteService
    • HealthService
    • IAuthorizationsService
    • IBackupService
    • IBucketsService
    • ICellsService
    • IChecksService
    • IConfigService
    • IDashboardsService
    • IDBRPsService
    • IDeleteService
    • IHealthService
    • IInvokableScriptsService
    • ILabelsService
    • ILegacyAuthorizationsService
    • IMetricsService
    • INotificationEndpointsService
    • INotificationRulesService
    • InvokableScriptsService
    • IOrganizationsService
    • IPingService
    • IQueryService
    • IReadyService
    • IRemoteConnectionsService
    • IReplicationsService
    • IResourcesService
    • IRestoreService
    • IRoutesService
    • IRulesService
    • IScraperTargetsService
    • ISecretsService
    • ISetupService
    • ISigninService
    • ISignoutService
    • ISourcesService
    • ITasksService
    • ITelegrafPluginsService
    • ITelegrafsService
    • ITemplatesService
    • IUsersService
    • IVariablesService
    • IViewsService
    • IWriteService
    • LabelsService
    • LegacyAuthorizationsService
    • MetricsService
    • NotificationEndpointsService
    • NotificationRulesService
    • OrganizationsService
    • PingService
    • QueryService
    • ReadyService
    • RemoteConnectionsService
    • ReplicationsService
    • ResourcesService
    • RestoreService
    • RoutesService
    • RulesService
    • ScraperTargetsService
    • SecretsService
    • SetupService
    • SigninService
    • SignoutService
    • SourcesService
    • TasksService
    • TelegrafPluginsService
    • TelegrafsService
    • TemplatesService
    • UsersService
    • VariablesService
    • ViewsService
    • WriteService
  • InfluxDB.Client.Core
    • Arguments
    • Column
    • LogLevel
    • Measurement
  • InfluxDB.Client.Core.Exceptions
    • BadGatewayException
    • BadRequestException
    • ForbiddenException
    • HttpException
    • HttpNotImplementedException
    • InfluxException
    • InternalServerErrorException
    • MethodNotAllowedException
    • NotAcceptableException
    • NotFoundException
    • PaymentRequiredException
    • ProxyAuthenticationRequiredException
    • RequestEntityTooLargeException
    • RequestTimeoutException
    • ServiceUnavailableException
    • TooManyRequestsException
    • UnauthorizedException
    • UnprocessableEntityException
  • InfluxDB.Client.Core.Flux.Domain
    • FluxColumn
    • FluxRecord
    • FluxTable
  • InfluxDB.Client.Core.Flux.Exceptions
    • FluxCsvParserException
    • FluxQueryException
  • InfluxDB.Client.Core.Flux.Serialization
    • AnnotatedCsvParser
    • IAnnotatedCsvParser
  • InfluxDB.Client.Domain
    • FindOptions
  • InfluxDB.Client.Flux
    • FluxClient
    • FluxClientFactory
    • FluxConnectionOptions
    • FluxConnectionOptions.AuthenticationType
    • IFluxClient
  • InfluxDB.Client.Linq
    • DefaultMemberNameResolver
    • IMemberNameResolver
    • InfluxDBQueryable<T>
    • MemberType
    • QueryableExtensions
    • QueryableOptimizerSettings
  • InfluxDB.Client.Writes
    • AbstractWriteEvent
    • InfluxDBEventArgs
    • PointData
    • PointData.Builder
    • PointSettings
    • WriteErrorEvent
    • WriteRetriableErrorEvent
    • WriteRuntimeExceptionEvent
    • WriteSuccessEvent

Class QueryApi

Inheritance
System.Object
InfluxDB.Client.Core.Internal.AbstractRestClient
InfluxDB.Client.Core.Internal.AbstractQueryClient
QueryApi
Implements
IQueryApi
Namespace: InfluxDB.Client
Assembly: InfluxDB.Client.dll
Syntax
public class QueryApi : AbstractQueryClient, IQueryApi

Constructors

QueryApi(InfluxDBClientOptions, QueryService, IFluxResultMapper)

Declaration
protected QueryApi(InfluxDBClientOptions options, QueryService service, IFluxResultMapper mapper)
Parameters
Type Name Description
InfluxDBClientOptions options
QueryService service
InfluxDB.Client.Core.Flux.Internal.IFluxResultMapper mapper

Fields

Dialect

Declaration
public static readonly Dialect Dialect
Field Value
Type Description
Dialect

Methods

AfterIntercept<T>(Int32, Func<IEnumerable<HeaderParameter>>, T)

Declaration
protected override T AfterIntercept<T>(int statusCode, Func<IEnumerable<HeaderParameter>> headers, T body)
Parameters
Type Name Description
System.Int32 statusCode
Func<IEnumerable<HeaderParameter>> headers
T body
Returns
Type Description
T
Type Parameters
Name Description
T

BeforeIntercept(RestRequest)

Declaration
protected override void BeforeIntercept(RestRequest request)
Parameters
Type Name Description
RestRequest request

QueryAsync(Query, Action<FluxRecord>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream FluxRecord to consumer.

Declaration
public Task QueryAsync(Query query, Action<FluxRecord> onNext, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

Action<FluxRecord> onNext

the callback to consume the FluxRecord result

Action<Exception> onError

the callback to consume any error notification

Action onComplete

the callback to consume a notification about successfully end of stream

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

async task

QueryAsync(Query, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and synchronously map whole response to FluxTables.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public async Task<List<FluxTable>> QueryAsync(Query query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<List<FluxTable>>

FluxTables that are matched the query

QueryAsync(Query, Type, Action<Object>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream Measurements to a consumer.

Declaration
public Task QueryAsync(Query query, Type pocoType, Action<object> onNext, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

Type pocoType

the type of measurement

Action<System.Object> onNext

the callback to consume the mapped Measurements

Action<Exception> onError

the callback to consume any error notification

Action onComplete

the callback to consume a notification about successfully end of stream

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

async task

QueryAsync(Query, Type, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and synchronously map whole response to list of object with given type.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public async Task<List<object>> QueryAsync(Query query, Type pocoType, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

Type pocoType

the type of measurement

System.String org

the organization

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<List<System.Object>>

Measurements which are matched the query

QueryAsync(String, Action<FluxRecord>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream FluxRecord to consumer.

Declaration
public Task QueryAsync(string query, Action<FluxRecord> onNext, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

Action<FluxRecord> onNext

the callback to consume the FluxRecord result

Action<Exception> onError

the callback to consume any error notification

Action onComplete

the callback to consume a notification about successfully end of stream

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

async task

QueryAsync(String, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and synchronously map whole response to FluxTables.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public Task<List<FluxTable>> QueryAsync(string query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<List<FluxTable>>

FluxTables that are matched the query

QueryAsync(String, Type, Action<Object>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream Measurements to a consumer.

Declaration
public Task QueryAsync(string query, Type pocoType, Action<object> onNext, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

Type pocoType

the type of measurement

Action<System.Object> onNext

the callback to consume the mapped Measurements

Action<Exception> onError

the callback to consume any error notification

Action onComplete

the callback to consume a notification about successfully end of stream

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

async task

QueryAsync(String, Type, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and synchronously map whole response to list of object with given type.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public Task<List<object>> QueryAsync(string query, Type pocoType, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

Type pocoType

the type of measurement

System.String org

the organization

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<List<System.Object>>

Measurements which are matched the query

QueryAsync<T>(Query, Action<T>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream Measurements to a consumer.

Declaration
public Task QueryAsync<T>(Query query, Action<T> onNext, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

Action<T> onNext

the callback to consume the mapped Measurements

Action<Exception> onError

the callback to consume any error notification

Action onComplete

the callback to consume a notification about successfully end of stream

System.String org

specifies the source organization

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

async task

Type Parameters
Name Description
T

the type of measurement

QueryAsync<T>(Query, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and synchronously map whole response to list of object with given type.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public async Task<List<T>> QueryAsync<T>(Query query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<List<T>>

Measurements which are matched the query

Type Parameters
Name Description
T

the type of measurement

QueryAsync<T>(String, Action<T>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream Measurements to a consumer.

Declaration
public Task QueryAsync<T>(string query, Action<T> onNext, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

Action<T> onNext

the callback to consume the mapped Measurements

Action<Exception> onError

the callback to consume any error notification

Action onComplete

the callback to consume a notification about successfully end of stream

System.String org

specifies the source organization

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

async task

Type Parameters
Name Description
T

the type of measurement

QueryAsync<T>(String, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and synchronously map whole response to list of object with given type.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public Task<List<T>> QueryAsync<T>(string query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<List<T>>

Measurements which are matched the query

Type Parameters
Name Description
T

the type of measurement

QueryAsyncEnumerable<T>(Query, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously maps response to enumerable of objects of type T.

Declaration
public async IAsyncEnumerable<T> QueryAsyncEnumerable<T>(Query query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

cancellation token

Returns
Type Description
IAsyncEnumerable<T>

Measurements which are matched the query

Type Parameters
Name Description
T

the type of measurement

QueryAsyncEnumerable<T>(String, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously maps response to enumerable of objects of type T.

Declaration
public async IAsyncEnumerable<T> QueryAsyncEnumerable<T>(string query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

cancellation token

Returns
Type Description
IAsyncEnumerable<T>

Measurements which are matched the query

Type Parameters
Name Description
T

the type of measurement

QueryRawAsync(Query, Action<String>, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream response (line by line) to .

Declaration
public Task QueryRawAsync(Query query, Action<string> onResponse, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

Action<System.String> onResponse

the callback to consume the response line by line

Action<Exception> onError

callback to consume any error notification

Action onComplete

callback to consume a notification about successfully end of stream

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

QueryRawAsync(Query, String, CancellationToken)

Executes the Flux query against the InfluxDB and synchronously map whole response to result.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public async Task<string> QueryRawAsync(Query query, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
Query query

the flux query to execute

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<System.String>

the raw response that matched the query

QueryRawAsync(String, Action<String>, Dialect, Action<Exception>, Action, String, CancellationToken)

Executes the Flux query against the InfluxDB 2.x and asynchronously stream response (line by line) to .

Declaration
public Task QueryRawAsync(string query, Action<string> onResponse, Dialect dialect = null, Action<Exception> onError = null, Action onComplete = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

Action<System.String> onResponse

the callback to consume the response line by line

Dialect dialect

Dialect is an object defining the options to use when encoding the response. See dialect SPEC.

Action<Exception> onError

callback to consume any error notification

Action onComplete

callback to consume a notification about successfully end of stream

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task

QueryRawAsync(String, Dialect, String, CancellationToken)

Executes the Flux query against the InfluxDB and synchronously map whole response to result.

NOTE: This method is not intended for large query results. Use for large data streaming.

Declaration
public Task<string> QueryRawAsync(string query, Dialect dialect = null, string org = null, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String query

the flux query to execute

Dialect dialect

Dialect is an object defining the options to use when encoding the response. See dialect SPEC.

System.String org

specifies the source organization. If the org is not specified then is used config from Org.

CancellationToken cancellationToken

Token that enables callers to cancel the request.

Returns
Type Description
Task<System.String>

the raw response that matched the query

Implements

IQueryApi
In This Article
Back to top Generated by DocFX