You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Overwrite: Perform an atomic write operation, overwriting any object present at the provided path.
45
+
- Create: Perform an atomic write operation, returning [`AlreadyExistsError`][obstore.exceptions.AlreadyExistsError] if an object already exists at the provided path.
46
+
- Update: Perform an atomic write operation if the current version of the object matches the provided [`UpdateVersion`][obstore.UpdateVersion], returning [`PreconditionError`][obstore.exceptions.PreconditionError] otherwise.
47
+
42
48
If a string is provided, it must be one of:
43
49
44
-
- `"overwrite"`: Perform an atomic write operation, overwriting any object present at the provided path.
45
-
- `"create"`: Perform an atomic write operation, returning [`AlreadyExistsError`][obstore.exceptions.AlreadyExistsError] if an object already exists at the provided path
50
+
- `"overwrite"`
51
+
- `"create"`
46
52
47
-
If a `dict` is provided, it must meet the criteria of `UpdateVersion`. In this case,
48
-
perform an atomic write operation if the current version of the object matches the
If a `dict` is provided, it must meet the criteria of
54
+
[`UpdateVersion`][obstore.UpdateVersion].
51
55
"""
52
56
53
57
classPutResult(TypedDict):
@@ -116,7 +120,9 @@ def put(
116
120
protocol.
117
121
118
122
Keyword args:
119
-
mode: Configure the `PutMode` for this operation. If this provided and is not `"overwrite"`, a non-multipart upload will be performed. Defaults to `"overwrite"`.
123
+
mode: Configure the [`PutMode`][obstore.PutMode] for this operation. Refer to the [`PutMode`][obstore.PutMode] docstring for more information.
124
+
125
+
If this provided and is not `"overwrite"`, a non-multipart upload will be performed. Defaults to `"overwrite"`.
120
126
attributes: Provide a set of `Attributes`. Defaults to `None`.
121
127
tags: Provide tags for this object. Defaults to `None`.
122
128
use_multipart: Whether to use a multipart upload under the hood. Defaults using a multipart upload if the length of the file is greater than `chunk_size`. When `use_multipart` is `False`, the entire input will be materialized in memory as part of the upload.
0 commit comments