FileQueryOptions | @azure/storage-file-datalake

Option interface for Data Lake file - query operations

See:

DataLakeFileClient.query

export
interface: FileQueryOptions

Hierarchy

CommonOptions
- FileQueryOptions

Index

Properties

Optional abortSignal

abortSignal: AbortSignalLike

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.

memberof: FileQueryOptions

Optional conditions

conditions: DataLakeRequestConditions

Conditions to meet when uploading to the block file.

memberof: FileQueryOptions

Optional inputTextConfiguration

inputTextConfiguration: FileQueryJsonTextConfiguration | FileQueryCsvTextConfiguration

Configurations for the query input.

memberof: FileQueryOptions

Optional onError

onError: undefined | ((error: FileQueryError) => void)

Callback to receive error events during the query operaiton.

memberof: FileQueryOptions

Optional onProgress

onProgress: undefined | ((progress: TransferProgressEvent) => void)

Callback to receive events on the progress of query operation.

memberof: FileQueryOptions

Optional outputTextConfiguration

outputTextConfiguration: FileQueryJsonTextConfiguration | FileQueryCsvTextConfiguration | FileQueryArrowConfiguration

Configurations for the query output.

memberof: FileQueryOptions

Optional tracingOptions

tracingOptions: OperationTracingOptions

Options to configure spans created when tracing is enabled.