AzureDestination

classView source ↗

class AzureDestination(
    uri: str | List[str],
    credentials: dict | AzureCredentials,
    format: str | dict | FileFormat = None,
)

Bases: Output

Categories: destination

Class for managing the configuration of Azure-file-based data outputs.

Attributes: format (FileFormat): The format of the file to be created. If not provided, it will be inferred from the file extension. uri (str | List[str]): The URI of the files with format: 'az://path/to/files'. It can be a single URI or a list of URIs. credentials (AzureCredentials): The credentials required to access Azure.

Methods: to_dict(): Converts the AzureDestination object to a dictionary.

Initializes the AzureDestination with the given URI and the credentials required to access Azure; and optionally a format.

Parameters

parameter

uristr | List[str]

The URI of the files to export with format: 'az://path/to/files'. It can be a single URI or a list of URIs.

parameter

credentialsdict | AzureCredentials

The credentials required to access Azure. Can be a dictionary or a AzureCredentials object.

parameter

formatstr | dict | FileFormat, optional

The format of the file. If not provided, it will be inferred from the file extension. Can be either a string with the format, a FileFormat object or a dictionary with the format as the 'type' key and any additional format-specific information. Currently supported formats are 'csv', 'parquet', 'ndjson' and 'jsonl'.

Raises

OutputConfigurationError FormatConfigurationError

Properties

property

credentialsAzureCredentials

The credentials required to access Azure.

property

formatFileFormat

The format of the file. If not provided, it will be inferred from the file extension of the URI.

property

uristr | List[str]

The URI of the files with format: 'az://path/to/files'.

class

View source ↗

SupportedFormats

class SupportedFormats(*args, **kwds)

Bases: Enum

Enum for the supported formats for the AzureDestination.

attribute

csv

attribute

ndjson

attribute

parquet

Methods

method

View source ↗

to_dict

def to_dict() -> dict

Converts the AzureDestination object to a dictionary with all the relevant information.

Returns:

dict: A dictionary with the relevant information of the AzureDestination object.