blob: d059e7339738cd8a517e9f2c900fba3e6c07cbd5 [file] [log] [blame] [view]
# Upgrade to v0.46
## Breaking change: Native blocking API removed
OpenDAL has removed the native blocking API in the core. The Python binding's blocking API now uses an async runtime internally. This is a transparent change and should not affect most users, but:
- The blocking API now requires an async runtime to be available
- Performance characteristics may be slightly different
- All blocking operations are now implemented as async operations running in a tokio runtime
## Breaking change: Removed services
The following services have been removed due to lack of maintainers and users:
- `atomicserver` - This service is no longer supported
- `icloud` - This service is no longer supported
- `nebula_graph` - This service is no longer supported
If you were using any of these services, you'll need to migrate to an alternative storage backend.
## Breaking change: Chainsafe service removed
The Chainsafe service has been sunset and is no longer available.
# Upgrade to v0.44
## Breaking change
Because of [a TLS lib issue](https://github.com/apache/opendal/issues/3650), we temporarily disable the `services-ftp` feature.
# Upgrade to v0.42
## Breaking change for layers
Operator and BlockingOperator won't accept `layers` anymore. Instead, we provide a `layer` API:
```python
op = opendal.Operator("memory").layer(opendal.layers.RetryLayer())
```
We removed not used layers `ConcurrentLimitLayer` and `ImmutableIndexLayer` along with this change.
## File and AsyncFile
OpenDAL removes `Reader` and `AsyncReader` classes, instead, we provide file-like object `File` and `AsyncFile`.
Open a file for reading in blocking way:
```python
with op.open(filename, "rb") as r:
content = r.read()
# With read options
with op.open(filename, "rb", offset=1024, size=2048) as r:
content = r.read()
```
Open a file for reading in async way:
```python
async with await op.open(filename, "rb") as r:
content = await r.read()
# With read options
async with await op.open(filename, "rb", offset=1024, size=2048) as r:
content = await r.read()
```
Open a file for writing:
```python
# Blocking write
with op.open(filename, "wb") as w:
w.write(b"hello world")
# With write options
with op.open(filename, "wb", content_type="text/plain", if_not_exists=True) as w:
w.write(b"hello world")
# Async write
async with await op.open(filename, "wb") as w:
await w.write(b"hello world")
```
## Breaking change for Errors
We remove the old error classes and provide a couple of Exception based class for the error handling.
1. `opendal.Error` is based class for all the exceptions now.
2. `opendal.exceptions.Unexpected` is added.
3. `opendal.exceptions.Unsupported` is added.
4. `opendal.exceptions.ConfigInvalid` is added.
5. `opendal.exceptions.NotFound` is added.
6. `opendal.exceptions.PermissionDenied` is added.
7. `opendal.exceptions.IsADirectory` is added.
8. `opendal.exceptions.NotADirectory` is added.
9. `opendal.exceptions.AlreadyExists` is added.
10. `opendal.exceptions.IsSameFile` is added.
11. `opendal.exceptions.ConditionNotMatch` is added.
12. `opendal.exceptions.ContentTruncated` is added.
13. `opendal.exceptions.ContentIncomplete` is added.
14. `opendal.exceptions.InvalidInput` is added.