FileQueryOptions interface

Option interface for Data Lake file - query operations

See:

Extends

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

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

conditions

Conditions to meet when uploading to the block file.

conditions?: DataLakeRequestConditions

Property Value

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

inputTextConfiguration

Configurations for the query input.

inputTextConfiguration?: FileQueryCsvTextConfiguration | FileQueryJsonTextConfiguration | FileQueryParquetConfiguration

Property Value

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

Inherited Property Details

tracingOptions

tracingOptions?: OperationTracingOptions

Property Value

Inherited From CommonOptions.tracingOptions