tabsdata.AzureDestination#
- class AzureDestination(uri: str | list[str], credentials: AzureCredentials, format: str | FileFormat = None)[source]#
Bases:
DestinationPluginClass for managing the configuration of Azure-file-based data outputs.
- format#
The format of the file to be created. If not provided, it will be inferred from the file extension.
- Type:
FileFormat
- uri#
The URI of the files with format: ‘az://path/to/files’. It can be a single URI or a list of URIs.
- credentials#
The credentials required to access Azure.
- Type:
AzureCredentials
- __init__(uri: str | list[str], credentials: AzureCredentials, format: str | FileFormat = None)[source]#
- Initializes the AzureDestination with the given URI and the credentials
required to access Azure; and optionally a format.
- Parameters:
uri (str | 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.
credentials (AzureCredentials) – The credentials required to access Azure. Must be an AzureCredentials object.
format (str | 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 or a FileFormat object. Currently supported formats are ‘csv’, ‘parquet’, ‘ndjson’ and ‘jsonl’.
- Raises:
OutputConfigurationError –
FormatConfigurationError –
Methods
__init__(uri, credentials[, format])Initializes the AzureDestination with the given URI and the credentials
chunk(working_dir, *results)Trigger the exporting of the data to local parquet chunks. This method will
stream(working_dir, *results)Trigger the exporting of the data. This method will receive the resulting data
write(files)Given a file or a list of files, write to the desired destination. Note: this
Attributes
allow_fragmentsWhether to allow fragments in the output.
The credentials required to access Azure.
The format of the file.
'az://path/to/files'.