Package version:

Interface BlockBlobQueryOptions

Options to configure BlockBlobClient.query operation.

interface BlockBlobQueryOptions {
    abortSignal?: any;
    conditions?: BlobRequestConditions;
    customerProvidedKey?: CpkInfo;
    inputTextConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryParquetConfiguration;
    onError?: ((error: BlobQueryError) => void);
    onProgress?: ((progress: TransferProgressEvent) => void);
    outputTextConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration;
    tracingOptions?: any;
}

Hierarchy (view full)

Properties

abortSignal? conditions? customerProvidedKey? inputTextConfiguration? onError? onProgress? outputTextConfiguration? tracingOptions?

Properties

OptionalabortSignal

abortSignal?: any

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.

Optionalconditions

conditions?: BlobRequestConditions

Conditions to meet when uploading to the block blob.

OptionalcustomerProvidedKey

customerProvidedKey?: CpkInfo

Customer Provided Key Info.

OptionalinputTextConfiguration

inputTextConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryParquetConfiguration

Configurations for the query input.

OptionalonError

onError?: ((error: BlobQueryError) => void)

Callback to receive error events during the query operaiton.

OptionalonProgress

onProgress?: ((progress: TransferProgressEvent) => void)

Callback to receive events on the progress of query operation.

OptionaloutputTextConfiguration

outputTextConfiguration?: BlobQueryJsonTextConfiguration | BlobQueryCsvTextConfiguration | BlobQueryArrowConfiguration

Configurations for the query output.

OptionaltracingOptions

tracingOptions?: any

Options to configure spans created when tracing is enabled.

Settings

Member Visibility