docs: update comment about r2 requiring locks #2261
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Cloudflare R2 doesn't require the use of an external lock when using conditional operation headers like so:
```rust
let s3 = AmazonS3Builder::from_env()
.with_url(url)
.with_region("auto")
.with_access_key_id(&config.s3_access_key_id)
.with_secret_access_key(&config.s3_secret_access_key)
.with_endpoint(&config.s3_endpoint)
// Allows using S3-API without an external locking provider since Cloudflare R2
// provides atomic Put and Copy.
.with_config(
AmazonS3ConfigKey::CopyIfNotExists,
"header: cf-copy-destination-if-none-match: *".to_string(),
)
.build()
```
- https://developers.cloudflare.com/r2/api/s3/extensions/#putobject-1
- https://github.com/apache/arrow-rs/blob/c6ba0f764a9142b74c9070db269de04d2701d112/object_store/src/aws/precondition.rs#L29-L42
rtyler
approved these changes
Mar 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Cloudflare R2 doesn't require the use of an external lock when using conditional operation headers like so:
Related Issue(s)
Documentation