Skip to main content

Filesystem interface to Azure-Datalake Gen1 and Gen2 Storage

PyPI version shields.io Latest conda-forge version

Quickstart

This package can be installed using:

pip install adlfs

or

conda install -c conda-forge adlfs

The adl:// and abfs:// protocols are included in fsspec's known_implementations registry in fsspec > 0.6.1, otherwise users must explicitly inform fsspec about the supported adlfs protocols.

To use the Gen1 filesystem:

import dask.dataframe as dd

storage_options={'tenant_id': TENANT_ID, 'client_id': CLIENT_ID, 'client_secret': CLIENT_SECRET}

dd.read_csv('adl://{STORE_NAME}/{FOLDER}/*.csv', storage_options=storage_options)

To use the Gen2 filesystem you can use the protocol abfs or az:

import dask.dataframe as dd

storage_options={'account_name': ACCOUNT_NAME, 'account_key': ACCOUNT_KEY}

ddf = dd.read_csv('abfs://{CONTAINER}/{FOLDER}/*.csv', storage_options=storage_options)
ddf = dd.read_parquet('az://{CONTAINER}/folder.parquet', storage_options=storage_options)

Accepted protocol / uri formats include:
'PROTOCOL://container/path-part/file'
'PROTOCOL://container@account.dfs.core.windows.net/path-part/file'

or optionally, if AZURE_STORAGE_ACCOUNT_NAME and an AZURE_STORAGE_<CREDENTIAL> is 
set as an environmental variable, then storage_options will be read from the environmental
variables

To read from a public storage blob you are required to specify the 'account_name'. For example, you can access NYC Taxi & Limousine Commission as:

storage_options = {'account_name': 'azureopendatastorage'}
ddf = dd.read_parquet('az://nyctlc/green/puYear=2019/puMonth=*/*.parquet', storage_options=storage_options)

Details

The package includes pythonic filesystem implementations for both Azure Datalake Gen1 and Azure Datalake Gen2, that facilitate interactions between both Azure Datalake implementations and Dask. This is done leveraging the intake/filesystem_spec base class and Azure Python SDKs.

Operations against both Gen1 Datalake currently only work with an Azure ServicePrincipal with suitable credentials to perform operations on the resources of choice.

Operations against the Gen2 Datalake are implemented by leveraging Azure Blob Storage Python SDK.

The filesystem can be instantiated with a variety of credentials, including:
    account_name
    account_key
    sas_token
    connection_string
    Azure ServicePrincipal credentials (which requires tenant_id, client_id, client_secret)
    anon
    location_mode:  valid value are "primary" or "secondary" and apply to RA-GRS accounts

The following enviornmental variables can also be set and picked up for authentication:
    "AZURE_STORAGE_CONNECTION_STRING"
    "AZURE_STORAGE_ACCOUNT_NAME"
    "AZURE_STORAGE_ACCOUNT_KEY"
    "AZURE_STORAGE_SAS_TOKEN"
    "AZURE_STORAGE_CLIENT_SECRET"
    "AZURE_STORAGE_CLIENT_ID"
    "AZURE_STORAGE_TENANT_ID"

The default value for anon (anonymous) is True.  If no explicit credentials are set, the
AzureBlobFileSystem will assume the account_name points to a public container, and attempt to use an anonymous login.

If anon (anonymous) is False, AzureBlobFileSystem will attempt to authenticate using Azure's 
DefaultAzureCredential() library.  Specifics of the types of authentication permitted can be
found [here](https://docs.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-pythonhttps://docs.microsoft.com/en-us/python/api/azure-identity/azure.identity.defaultazurecredential?view=azure-python)

The AzureBlobFileSystem accepts all of the Async BlobServiceClient arguments.

By default, write operations create BlockBlobs in Azure, which, once written can not be appended.  It is possible to create an AppendBlob using an `mode="ab"` when creating, and then when operating on blobs.  Currently AppendBlobs are not available if hierarchical namespaces are enabled.

Metadata

Release files for adlfs 2022.9.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adlfs 2022.9.0
File Size Uploaded Provenance Actions
adlfs-2022.9.0.tar.gz 41.2 kB Without provenance Details for adlfs-2022.9.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for adlfs 2022.9.0
File Interpreter ABI Platform Actions
adlfs-2022.9.0-py3-none-any.whl Python 3 none any Details for adlfs-2022.9.0-py3-none-any.whl

Total release size: 65.2 kB

Release files / adlfs-2022.9.0.tar.gz

Download URL adlfs-2022.9.0.tar.gz
Size 41.2 kB
Tags Source
SHA-256 checksum
How to use checksums
56f4a8873c87dc29a0c1b9c3fcbc5fd708f30428cb41740ef57ad935ef72398b
BLAKE2b-256 checksum
How to use checksums
3632286725e71f87744d4f7760f078bb30fa897db234896909870612de10e6d3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Release files / adlfs-2022.9.0-py3-none-any.whl

Download URL adlfs-2022.9.0-py3-none-any.whl
Size 24.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
6c4b7f39ad0e83d5e949946ee863b48c243e73b0c365dae9d9dae504d32f5cd5
BLAKE2b-256 checksum
How to use checksums
91a7eceaed9fce468aba7d6af3aa04b2a7ce116083789471ed91ae85403d6ef1
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.13

Security for adlfs 2022.9.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2022.9.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page