DataLakeFileClient.QueryAsync Method

Definition

Namespace:

Azure.Storage.Files.DataLake

Assembly:

Azure.Storage.Files.DataLake.dll

Package:

Azure.Storage.Files.DataLake v12.20.1

Source:

DataLakeFileClient.cs

The Query(String, DataLakeQueryOptions, CancellationToken) API returns the result of a query against the file.

public virtual System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>> QueryAsync (string querySqlExpression, Azure.Storage.Files.DataLake.Models.DataLakeQueryOptions options = default, System.Threading.CancellationToken cancellationToken = default);

abstract member QueryAsync : string * Azure.Storage.Files.DataLake.Models.DataLakeQueryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>>
override this.QueryAsync : string * Azure.Storage.Files.DataLake.Models.DataLakeQueryOptions * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Response<Azure.Storage.Files.DataLake.Models.FileDownloadInfo>>

Public Overridable Function QueryAsync (querySqlExpression As String, Optional options As DataLakeQueryOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Response(Of FileDownloadInfo))

Parameters

querySqlExpression

String

The query. For a sample SQL query expression, see this article.

options

DataLakeQueryOptions

Optional parameters.

cancellationToken

CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Task<Response<FileDownloadInfo>>

A Response<T>.

Remarks

A RequestFailedException will be thrown if a failure occurs.