Skip to content

Commit 7b09e4e

Browse files
authored
Documentation for backend support of bulk delete (#571)
1 parent 65ad88b commit 7b09e4e

1 file changed

Lines changed: 17 additions & 0 deletions

File tree

src/lib.rs

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -859,6 +859,23 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync + Debug + 'static {
859859
/// than one object per a request. Otherwise, the implementation may call
860860
/// the single object delete method for each location.
861861
///
862+
/// # Bulk Delete Support
863+
///
864+
/// The following backends support native bulk delete operations:
865+
///
866+
/// - **AWS (S3)**: Uses the native [DeleteObjects] API with batches of up to 1000 objects
867+
/// - **Azure**: Uses the native [Blob Batch] API with batches of up to 256 objects
868+
///
869+
/// The following backends use concurrent individual delete operations:
870+
///
871+
/// - **GCP**: Performs individual delete requests with up to 10 concurrent operations
872+
/// - **HTTP**: Performs individual delete requests with up to 10 concurrent operations
873+
/// - **Local**: Performs individual file deletions with up to 10 concurrent operations
874+
/// - **Memory**: Performs individual in-memory deletions sequentially
875+
///
876+
/// [DeleteObjects]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html
877+
/// [Blob Batch]: https://learn.microsoft.com/en-us/rest/api/storageservices/blob-batch
878+
///
862879
/// The returned stream yields the results of the delete operations in the
863880
/// same order as the input locations. However, some errors will be from
864881
/// an overall call to a bulk delete operation, and not from a specific

0 commit comments

Comments
 (0)