1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
// Copyright 2022 Datafuse Labs.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//! Azure Data Lake Storage Gen2 Support.
//!
//! As known as `abfs`, `azdfs` or `azdls`.
//!
//! This service will visist the [ABFS](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-abfs-driver) URI supported by [Azure Data Lake Storage Gen2](https://learn.microsoft.com/en-us/azure/storage/blobs/data-lake-storage-introduction).
//!
//! # 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:
//!
//! ```shell
//! 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
//! ```
//!
//! ```no_run
//! 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
//!
//! ```no_run
//! 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(())
//! }
//! ```
mod backend;
pub use backend::Builder;
mod dir_stream;
mod error;