BlockBlobQueryOptions interface

Package:

@azure/storage-blob

Options to configure <xref:BlockBlobClient.query> operation.

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 blob.
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.
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 blob.

conditions?: BlobRequestConditions

Property Value

BlobRequestConditions

customerProvidedKey

Customer Provided Key Info.

customerProvidedKey?: CpkInfo

Property Value

CpkInfo

inputTextConfiguration

Configurations for the query input.

inputTextConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryParquetConfiguration

Property Value

BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryParquetConfiguration

onError

Callback to receive error events during the query operaiton.

onError?: (error: BlobQueryError) => void

Property Value

(error: BlobQueryError) => 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?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration

Property Value

BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration

tracingOptions

Options to configure spans created when tracing is enabled.

tracingOptions?: OperationTracingOptions

Property Value

OperationTracingOptions