This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/arrow-rs-object-store.git
The following commit(s) were added to refs/heads/main by this push:
new 7b09e4e Documentation for backend support of bulk delete (#571)
7b09e4e is described below
commit 7b09e4e2521d29bb51264800b6a33430149aa2ab
Author: John Vandenberg <[email protected]>
AuthorDate: Fri Dec 19 01:19:35 2025 +0800
Documentation for backend support of bulk delete (#571)
---
src/lib.rs | 17 +++++++++++++++++
1 file changed, 17 insertions(+)
diff --git a/src/lib.rs b/src/lib.rs
index 6ffdf6d..3448055 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -859,6 +859,23 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync +
Debug + 'static {
/// than one object per a request. Otherwise, the implementation may call
/// the single object delete method for each location.
///
+ /// # Bulk Delete Support
+ ///
+ /// The following backends support native bulk delete operations:
+ ///
+ /// - **AWS (S3)**: Uses the native [DeleteObjects] API with batches of up
to 1000 objects
+ /// - **Azure**: Uses the native [Blob Batch] API with batches of up to
256 objects
+ ///
+ /// The following backends use concurrent individual delete operations:
+ ///
+ /// - **GCP**: Performs individual delete requests with up to 10
concurrent operations
+ /// - **HTTP**: Performs individual delete requests with up to 10
concurrent operations
+ /// - **Local**: Performs individual file deletions with up to 10
concurrent operations
+ /// - **Memory**: Performs individual in-memory deletions sequentially
+ ///
+ /// [DeleteObjects]:
https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html
+ /// [Blob Batch]:
https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
+ ///
/// The returned stream yields the results of the delete operations in the
/// same order as the input locations. However, some errors will be from
/// an overall call to a bulk delete operation, and not from a specific
