This is an automated email from the ASF dual-hosted git repository.
tustvold pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new 7429b5cf9 update doc for object_store copy_if_not_exists (#2653)
7429b5cf9 is described below
commit 7429b5cf99c025d170afc26e9a821baff6ebf36a
Author: JanKaul <[email protected]>
AuthorDate: Mon Sep 5 18:52:19 2022 +0200
update doc for object_store copy_if_not_exists (#2653)
---
object_store/src/lib.rs | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/object_store/src/lib.rs b/object_store/src/lib.rs
index 9ed9db9e9..16f0c6f3a 100644
--- a/object_store/src/lib.rs
+++ b/object_store/src/lib.rs
@@ -290,6 +290,10 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync +
Debug + 'static {
/// Copy an object from one path to another, only if destination is empty.
///
/// Will return an error if the destination already has an object.
+ ///
+ /// Performs an atomic operation if the underlying object storage supports
it.
+ /// If atomic operations are not supported by the underlying object
storage (like S3)
+ /// it will return an error.
async fn copy_if_not_exists(&self, from: &Path, to: &Path) -> Result<()>;
/// Move an object from one path to another in the same object store.
