FileQueryOptions interface

Package:

@azure/storage-file-datalake

Option interface for Data Lake file - query operations

See:

• query

Extends

CommonOptions

Properties

abortSignal	An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.
conditions	Conditions to meet when uploading to the block file.
customerProvidedKey	Customer Provided Key Info.
inputTextConfiguration	Configurations for the query input.
onError	Callback to receive error events during the query operaiton.
onProgress	Callback to receive events on the progress of query operation.
outputTextConfiguration	Configurations for the query output.

Inherited Properties

tracingOptions

Options to configure spans created when tracing is enabled.

Property Details

abortSignal

An implementation of the AbortSignalLike interface to signal the request to cancel the operation. For example, use the @azure/abort-controller to create an AbortSignal.

abortSignal?: AbortSignalLike

Property Value

AbortSignalLike

conditions

Conditions to meet when uploading to the block file.

conditions?: DataLakeRequestConditions

Property Value

DataLakeRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

inputTextConfiguration

Configurations for the query input.

inputTextConfiguration?: FileQueryCsvTextConfiguration | FileQueryJsonTextConfiguration | FileQueryParquetConfiguration

Property Value

FileQueryCsvTextConfiguration | FileQueryJsonTextConfiguration | FileQueryParquetConfiguration

onError

Callback to receive error events during the query operaiton.

onError?: (error: FileQueryError) => void

Property Value

(error: FileQueryError) => void

onProgress

Callback to receive events on the progress of query operation.

onProgress?: (progress: TransferProgressEvent) => void

Property Value

(progress: TransferProgressEvent) => void

outputTextConfiguration

Configurations for the query output.

outputTextConfiguration?: BlobQueryArrowConfiguration | FileQueryCsvTextConfiguration | FileQueryJsonTextConfiguration

Property Value

BlobQueryArrowConfiguration | FileQueryCsvTextConfiguration | FileQueryJsonTextConfiguration

Inherited Property Details

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions

Inherited From CommonOptions.tracingOptions