Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(object-store): add warning to flush #5369

Merged
merged 3 commits into from
Feb 7, 2024
Merged

docs(object-store): add warning to flush #5369

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7a8f017
add warning to flush
wjones127 Feb 6, 2024
19d6e48
Update object_store/src/lib.rs
wjones127 Feb 6, 2024
ee43d4e
format
wjones127 Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions object_store/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,15 @@ pub trait ObjectStore: std::fmt::Display + Send + Sync + Debug + 'static {
/// writer fails or panics, you must call [ObjectStore::abort_multipart]
/// to clean up partially written data.
///
/// <div class="warning">
/// It is recommended applications wait for any in-flight requests to complete by calling `flush`, if
/// there may be a significant gap in time (> ~30s) before the next write.
/// These gaps can include times where the function returns control to the
/// caller while keeping the writer open. If `flush` is not called, futures
/// for in-flight requests may be left unpolled long enough for the requests
/// to time out, causing the write to fail.
/// </div>
///
/// For applications requiring fine-grained control of multipart uploads
/// see [`MultiPartStore`], although note that this interface cannot be
/// supported by all [`ObjectStore`] backends.
Expand Down
Loading