DataLakeFileClient.Query Method

Reference

Definition

Namespace:: Azure.Storage.Files.DataLake

Assembly:: Azure.Storage.Files.DataLake.dll

Package:: Azure.Storage.Files.DataLake v12.17.1

Package:: Azure.Storage.Files.DataLake v12.18.0-beta.2

Source:: DataLakeFileClient.cs

Source:: DataLakeFileClient.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

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

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

Public Overridable Function Query (querySqlExpression As String, Optional options As DataLakeQueryOptions = Nothing, Optional cancellationToken As CancellationToken = Nothing) As 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

Response<FileDownloadInfo>

A Response<T>.

Remarks

A RequestFailedException will be thrown if a failure occurs.

Applies to