BlobQueryReader Class

A streaming object to read query results.

Inheritance

builtins.object

BlobQueryReader

Constructor

BlobQueryReader(name=None, container=None, errors=None, record_delimiter='\n', encoding=None, headers=None, response=None, error_cls=None)

Parameters

name

default value: None

container

default value: None

errors

default value: None

record_delimiter

default value:

encoding

default value: None

headers

default value: None

response

default value: None

error_cls

default value: None

Variables

name

str

The name of the blob being quered.

container

str

The name of the container where the blob is.

response_headers

dict

The response_headers of the quick query request.

record_delimiter

bytes

The delimiter used to separate lines, or records with the data. The records method will return these lines via a generator.

Methods

readall	Return all query results. This operation is blocking until all data is downloaded. If encoding has been configured - this will be used to decode individual records are they are received.
readinto	Download the query result to a stream.
records	Returns a record generator for the query result. Records will be returned line by line. If encoding has been configured - this will be used to decode individual records are they are received.

readall

Return all query results.

This operation is blocking until all data is downloaded. If encoding has been configured - this will be used to decode individual records are they are received.

readall() -> Union[bytes, str]

Return type

<xref:Union>[bytes, str]

readinto

Download the query result to a stream.

readinto(stream: IO) -> None

Parameters

stream

Required

The stream to download to. This can be an open file-handle, or any writable stream.

Returns

None

records

Returns a record generator for the query result.

Records will be returned line by line. If encoding has been configured - this will be used to decode individual records are they are received.

records() -> Iterable[Union[bytes, str]]

Return type

<xref:Iterable>[<xref:Union>[bytes, str]]