Module opendal::services::azdfs

Azure Data Lake Storage Gen2 Support.

As known as abfs, azdfs or azdls.

This service will visist the ABFS URI supported by Azure Data Lake Storage Gen2.

Configuration

• root: Set the work dir for backend.
• filesystem: Set the filesystem name for backend.
• endpoint: Set the endpoint for backend.
• account_name: Set the account_name for backend.
• account_key: Set the account_key for backend.

Refer to Builder’s public API docs for more information.

Environment

• OPENDAL_AZDFS_ROOT
• OPENDAL_AZDFS_FILESYSTEM
• OPENDAL_AZDFS_ENDPOINT
• OPENDAL_AZDFS_ACCOUNT_NAME
• OPENDAL_AZDFS_ACCOUNT_KEY

Example

Init OpenDAL Operator

Via Environment

Set environment correctly:

export OPENDAL_AZDFS_ROOT=/path/to/dir/
export OPENDAL_AZDFS_FILESYSTEM=test
export OPENDAL_AZDFS_ENDPOINT=https://accountname.dfs.core.windows.net
export OPENDAL_AZDFS_ACCOUNT_KEY=accountname
export OPENDAL_AZDFS_ACCOUNT_KEY=accountkey

use std::sync::Arc;

use anyhow::Result;
use opendal::Object;
use opendal::Operator;
use opendal::Scheme;

#[tokio::main]
async fn main() -> Result<()> {
    let op: Operator = Operator::from_env(Scheme::Azdfs)?;

    // Create an object handle to start operation on object.
    let _: Object = op.object("test_file");

    Ok(())
}

Via Builder

use std::sync::Arc;

use anyhow::Result;
use opendal::services::azdfs;
use opendal::Object;
use opendal::Operator;

#[tokio::main]
async fn main() -> Result<()> {
    // Create azblob backend builder.
    let mut builder = azdfs::Builder::default();
    // Set the root for azblob, all operations will happen under this root.
    //
    // NOTE: the root must be absolute path.
    builder.root("/path/to/dir");
    // Set the filesystem name, this is required.
    builder.filesystem("test");
    // Set the endpoint, this is required.
    //
    // For examples:
    // - "https://accountname.dfs.core.windows.net"
    builder.endpoint("https://accountname.dfs.core.windows.net");
    // Set the account_name and account_key.
    //
    // OpenDAL will try load credential from the env.
    // If credential not set and no valid credential in env, OpenDAL will
    // send request without signing like anonymous user.
    builder.account_name("account_name");
    builder.account_key("account_key");

    // `Accessor` provides the low level APIs, we will use `Operator` normally.
    let op: Operator = Operator::new(builder.build()?);

    // Create an object handle to start operation on object.
    let _: Object = op.object("test_file");

    Ok(())
}

Structs

Builder

Builder for azblob services