opendal 0.1.6.pre.rc.1-arm64-darwin-23

data/core/src/services/aliyun_drive/docs.md

@@ -0,0 +1,61 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [x] rename
+- [x] list
+- [ ] presign
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work dir for backend.
+- `access_token`: Set the access_token for backend.
+- `client_id`: Set the client_id for backend.
+- `client_secret`: Set the client_secret for backend.
+- `refresh_token`: Set the refresh_token for backend.
+- `drive_type`: Set the drive_type for backend.
+
+Refer to [`AliyunDriveBuilder`]`s  public API docs for more information.
+
+## Example
+
+### Basic Setup
+
+```rust,no_run
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::AliyunDrive;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // Create aliyun-drive backend builder.
+    let mut builder = AliyunDrive::default()
+        // Set the root for aliyun-drive, all operations will happen under this root.
+        //
+        // NOTE: the root must be absolute path.
+        .root("/path/to/dir")
+        // Set the client_id. This is required.
+        .client_id("client_id")
+        // Set the client_secret. This is required.
+        .client_secret("client_secret")
+        // Set the refresh_token. This is required.
+        .refresh_token("refresh_token")
+        // Set the drive_type. This is required.
+        //
+        // Fallback to the default type if no other types found.
+        .drive_type("resource");
+
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/alluxio/docs.md

@@ -0,0 +1,45 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [x] rename
+- [x] list
+- [ ] presign
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work directory for backend
+- `endpoint`: Customizable endpoint setting
+
+You can refer to [`AlluxioBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::Alluxio;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // create backend builder
+    let mut builder = Alluxio::default()
+        // set the storage bucket for OpenDAL
+        .root("/")
+        // set the endpoint for OpenDAL
+        .endpoint("http://127.0.0.1:39999");
+
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/azblob/docs.md

@@ -0,0 +1,77 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] append
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [ ] rename
+- [x] list
+- [x] presign
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work dir for backend.
+- `container`: Set the container 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 public API docs for more information.
+
+## Examples
+
+This example works on [Azurite](https://github.com/Azure/Azurite) for local developments.
+
+### Start local blob service
+
+```shell
+docker run -p 10000:10000 mcr.microsoft.com/azure-storage/azurite
+az storage container create --name test --connection-string "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+```
+
+### Init OpenDAL Operator
+
+### Via Builder
+
+```rust,no_run
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::Azblob;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // Create azblob backend builder.
+    let mut builder = Azblob::default()
+        // Set the root for azblob, all operations will happen under this root.
+        //
+        // NOTE: the root must be absolute path.
+        .root("/path/to/dir")
+        // Set the container name, this is required.
+        .container("test")
+        // Set the endpoint, this is required.
+        //
+        // For examples:
+        // - "http://127.0.0.1:10000/devstoreaccount1"
+        // - "https://accountname.blob.core.windows.net"
+        .endpoint("http://127.0.0.1:10000/devstoreaccount1")
+        // 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.
+        .account_name("devstoreaccount1")
+        .account_key("Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==");
+
+    // `Accessor` provides the low level APIs, we will use `Operator` normally.
+    let op: Operator = Operator::new(builder)?.finish();
+    Ok(())
+}
+```

data/core/src/services/azdls/docs.md

@@ -0,0 +1,73 @@
+As known as `abfs`, `azdls` or `azdls`.
+
+This service will visit 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).
+
+## Notes
+
+`azdls` is different from `azfile` service which used to visit [Azure File Storage](https://azure.microsoft.com/en-us/services/storage/files/).
+
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [x] rename
+- [x] list
+- [ ] presign
+- [ ] blocking
+
+## 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 public API docs for more information.
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::Azdls;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // Create azdls backend builder.
+    let mut builder = Azdls::default()
+        // Set the root for azdls, all operations will happen under this root.
+        //
+        // NOTE: the root must be absolute path.
+        .root("/path/to/dir")
+        // Set the filesystem name, this is required.
+        .filesystem("test")
+        // Set the endpoint, this is required.
+        //
+        // For examples:
+        // - "https://accountname.dfs.core.windows.net"
+        .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.
+        .account_name("account_name")
+        .account_key("account_key");
+
+    // `Accessor` provides the low level APIs, we will use `Operator` normally.
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/azfile/docs.md

@@ -0,0 +1,65 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [x] rename
+- [x] list
+- [ ] presign
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work dir for backend.
+- `endpoint`: Set the endpoint for backend.
+- `account_name`: Set the account_name for backend.
+- `account_key`: Set the account_key for backend.
+- `share_name`: Set the share_name for backend.
+
+Refer to public API docs for more information.
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::Azfile;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+  // Create azfile backend builder.
+  let mut builder = Azfile::default()
+      // Set the root for azfile, all operations will happen under this root.
+      //
+      // NOTE: the root must be absolute path.
+      .root("/path/to/dir")
+      // Set the filesystem name, this is required.
+      .share_name("test")
+      // Set the endpoint, this is required.
+      //
+      // For examples:
+      // - "https://accountname.file.core.windows.net"
+      .endpoint("https://accountname.file.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.
+      .account_name("account_name")
+      .account_key("account_key");
+
+  // `Accessor` provides the low level APIs, we will use `Operator` normally.
+  let op: Operator = Operator::new(builder)?.finish();
+
+  Ok(())
+}
+```

data/core/src/services/b2/docs.md

@@ -0,0 +1,54 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [ ] rename
+- [x] list
+- [x] presign
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work directory for backend
+- `key_id`: B2 application key keyID
+- `application_key` B2 application key applicationKey
+- `bucket` B2 bucket name
+- `bucket_id` B2 bucket_id
+
+You can refer to [`B2Builder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::B2;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // create backend builder
+    let mut builder = B2::default()
+        // set the storage bucket for OpenDAL
+        .root("/")
+        // set the key_id for OpenDAL
+        .application_key_id("xxxxxxxxxx")
+        // set the key_id for OpenDAL
+        .application_key("xxxxxxxxxx")
+        // set the     bucket name for OpenDAL
+        .bucket("opendal")
+        // set the bucket_id for OpenDAL
+        .bucket_id("xxxxxxxxxxxxx");
+
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/cacache/docs.md

@@ -0,0 +1,38 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [ ] rename
+- [ ] list
+- [ ] ~~presign~~
+- [x] blocking
+
+## Configuration
+
+- `datadir`: Set the path to the cacache data directory
+
+You can refer to [`CacacheBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::Cacache;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let mut builder = Cacache::default().datadir("/tmp/opendal/cacache");
+
+    let op: Operator = Operator::new(builder)?.finish();
+    Ok(())
+}
+```

data/core/src/services/cloudflare_kv/docs.md

@@ -0,0 +1,21 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [ ] rename
+- [x] list
+- [ ] ~~presign~~
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the working directory of `OpenDAL`
+- `api_token`: Set the token of cloudflare api
+- `account_id`: Set the account identifier of cloudflare
+- `namespace_id`: Set the namespace identifier of d1

data/core/src/services/cos/docs.md

@@ -0,0 +1,55 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [ ] rename
+- [x] list
+- [ ] presign
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work directory for backend
+- `bucket`: Set the container name for backend
+- `endpoint`: Customizable endpoint setting
+- `access_key_id`: Set the access_key_id for backend.
+- `secret_access_key`: Set the secret_access_key for backend.
+
+You can refer to [`CosBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::Cos;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    // create backend builder
+    let mut builder = Cos::default()
+        // set the storage bucket for OpenDAL
+        .bucket("test")
+        // set the endpoint for OpenDAL
+        .endpoint("https://cos.ap-singapore.myqcloud.com")
+        // Set the access_key_id and secret_access_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.
+        .secret_id("secret_id")
+        .secret_key("secret_access_key");
+
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/d1/docs.md

@@ -0,0 +1,48 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [ ] rename
+- [ ] ~~list~~
+- [ ] ~~presign~~
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the working directory of `OpenDAL`
+- `token`: Set the token of cloudflare api
+- `account_id`: Set the account id of cloudflare api
+- `database_id`: Set the database id of cloudflare api
+- `table`: Set the table of D1 Database
+- `key_field`: Set the key field of D1 Database
+- `value_field`: Set the value field of D1 Database
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::D1;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let mut builder = D1::default()
+        .token("token")
+        .account_id("account_id")
+        .database_id("database_id")
+        .table("table")
+        .key_field("key_field")
+        .value_field("value_field");
+
+    let op = Operator::new(builder)?.finish();
+    Ok(())
+}
+```

data/core/src/services/dashmap/docs.md

@@ -0,0 +1,38 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [x] rename
+- [x] list
+- [ ] presign
+
+## Configuration
+
+- `root`: Set the root path for this dashmap instance.
+
+You can refer to [`DashmapBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::services::Dashmap;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let mut builder = Dashmap::default()
+        .root("/");
+
+    let op: Operator = Operator::new(builder)?.finish();
+    Ok(())
+}
+```

data/core/src/services/dbfs/docs.md

@@ -0,0 +1,57 @@
+This service will visit the [DBFS API](https://docs.databricks.com/api/azure/workspace/dbfs) supported by [Databricks File System](https://docs.databricks.com/en/dbfs/index.html).
+
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [ ] copy
+- [x] rename
+- [x] list
+- [ ] ~~presign~~
+- [ ] blocking
+
+## Configurations
+
+- `root`: Set the work directory for backend.
+- `endpoint`: Set the endpoint for backend.
+- `token`: Databricks personal access token.
+
+Refer to [`DbfsBuilder`]'s public API docs for more information.
+
+## Examples
+
+### Via Builder
+
+```rust,no_run
+use std::sync::Arc;
+
+use anyhow::Result;
+use opendal::services::Dbfs;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let mut builder = Dbfs::default()
+        // set the root for Dbfs, all operations will happen under this root
+        //
+        // Note:
+        // if the root is not exists, the builder will automatically create the
+        // root directory for you
+        // if the root exists and is a directory, the builder will continue working
+        // if the root exists and is a folder, the builder will fail on building backend
+        .root("/path/to/dir")
+        // set the endpoint of Dbfs workspace
+        .endpoint("https://adb-1234567890123456.78.azuredatabricks.net")
+        // set the personal access token for builder
+        .token("access_token");
+
+    let op: Operator = Operator::new(builder)?.finish();
+
+    Ok(())
+}
+```

data/core/src/services/dropbox/docs.md

@@ -0,0 +1,64 @@
+## Capabilities
+
+This service can be used to:
+
+- [x] stat
+- [x] read
+- [x] write
+- [x] create_dir
+- [x] delete
+- [x] copy
+- [x] rename
+- [x] list
+- [x] batch
+- [ ] blocking
+
+## Configuration
+
+- `root`: Set the work directory for this backend.
+
+### Credentials related
+
+#### Just provide Access Token (Temporary)
+
+- `access_token`: set the access_token for this backend.
+Please notice its expiration.
+
+#### Or provide Client ID and Client Secret and refresh token (Long Term)
+
+If you want to let OpenDAL to refresh the access token automatically,
+please provide the following fields:
+
+- `refresh_token`: set the refresh_token for dropbox api
+- `client_id`: set the client_id for dropbox api
+- `client_secret`: set the client_secret for dropbox api
+
+OpenDAL is a library, it cannot do the first step of OAuth2 for you.
+You need to get authorization code from user by calling Dropbox's authorize url
+and exchange it for refresh token.
+
+Please refer to [Dropbox OAuth2 Guide](https://www.dropbox.com/developers/reference/oauth-guide)
+for more information.
+
+You can refer to [`DropboxBuilder`]'s docs for more information
+
+## Example
+
+### Via Builder
+
+```rust,no_run
+use anyhow::Result;
+use opendal::raw::OpWrite;
+use opendal::services::Dropbox;
+use opendal::Operator;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    let mut builder = Dropbox::default()
+        .root("/opendal")
+        .access_token("<token>");
+
+    let op: Operator = Operator::new(builder)?.finish();
+    Ok(())
+}
+```