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.

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

Bump version to 0.28 #1401

Merged
merged 1 commit into from
Feb 22, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,24 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/)
and this project adheres to [Semantic Versioning](https://semver.org/).

## [v0.28.0] - 2023-02-22

### Added

- feat: add dashmap support (#1390)

### Changed

- refactor: Implement query based object metadata cache (#1395)
- refactor: Store complete inside bits and add more examples (#1397)
- refactor: Trigger panic if users try to visit not fetched metadata (#1399)
- refactor: Polish the implement of Query Based Metadata Cache (#1400)

### Docs

- RFC-1391: Object Metadataer (#1391)
- RFC-1398: Query Based Metadata (#1398)

## [v0.27.2] - 2023-02-20

### Added
Expand Down Expand Up @@ -1396,6 +1414,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/).

Hello, OpenDAL!

[v0.28.0]: https://github.com/datafuselabs/opendal/compare/v0.27.2...v0.28.0
[v0.27.2]: https://github.com/datafuselabs/opendal/compare/v0.27.1...v0.27.2
[v0.27.1]: https://github.com/datafuselabs/opendal/compare/v0.27.0...v0.27.1
[v0.27.0]: https://github.com/datafuselabs/opendal/compare/v0.26.2...v0.27.0
Expand Down
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ keywords = ["storage", "fs", "s3", "azblob", "gcs"]
license = "Apache-2.0"
name = "opendal"
repository = "https://github.com/datafuselabs/opendal"
version = "0.27.2"
version = "0.28.0"
# MSRV of OpenDAL. Please update this field while bump.
rust-version = "1.60"

Expand Down
2 changes: 1 addition & 1 deletion binaries/oay/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion binaries/oay/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ clap = { version = "4", features = ["cargo"] }
env_logger = "0.10"
futures = "0.3"
log = "0.4"
opendal = { version = "0.27", path = "../../" }
opendal = { version = "0.28", path = "../../" }
percent-encoding = "2"
sluice = "0.5"
tokio = { version = "1.20", features = ["rt-multi-thread", "macros"] }
2 changes: 1 addition & 1 deletion binaries/oli/Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion binaries/oli/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ anyhow = "1"
clap = { version = "4", features = ["cargo", "string"] }
env_logger = "0.10"
log = "0.4"
opendal = { version = "0.27", path = "../../" }
opendal = { version = "0.28", path = "../../" }
tokio = { version = "1.20", features = ["fs", "macros", "rt-multi-thread"] }

[dev-dependencies]
Expand Down
2 changes: 1 addition & 1 deletion bindings/nodejs/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ crate-type = ["cdylib"]
[dependencies]
napi = "2"
napi-derive = "2"
opendal = { version = "0.27", path = "../../" }
opendal = { version = "0.28", path = "../../" }

[build-dependencies]
napi-build = "2"
2 changes: 1 addition & 1 deletion bindings/object_store/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ bytes = "1"
chrono = "0.4.23"
futures = "0.3"
object_store = "0.5"
opendal = { version = "0.27", path = "../../" }
opendal = { version = "0.28", path = "../../" }
tokio = "1"

[dev-dependencies]
Expand Down
2 changes: 1 addition & 1 deletion bindings/python/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@ crate-type = ["cdylib"]
name = "opendal"

[dependencies]
opendal = { version = "0.27", path = "../../" }
opendal = { version = "0.28", path = "../../" }
pyo3 = { version = "0.18", features = ["extension-module"] }
14 changes: 14 additions & 0 deletions src/docs/upgrade.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,17 @@
# Upgrade to v0.28

In v0.28, we introduced [Query Based Metadata][crate::docs::rfcs::rfc_1398_query_based_metadata]. Users can query cached metadata with [`ObjectMetakey`][crate::ObjectMetakey] to make sure that OpenDAL always makes the best decision.

```diff
- pub async fn metadata(&self) -> Result<ObjectMetadata>;
+ pub async fn metadata(
+ &self,
+ flags: impl Into<FlagSet<ObjectMetakey>>,
+ ) -> Result<Arc<ObjectMetadata>>;
```

Please visit [`Object::metadata()`][crate::Object::metadata()]'s example for more details.

# Upgrade to v0.27

In v0.27, we refactored our `list` related logic and added `scan` support. So make `Pager` and `BlockingPager` associated types in `Accessor` too!
Expand Down
32 changes: 12 additions & 20 deletions src/object/object.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1121,12 +1121,10 @@ impl Object {
///
/// - Want detect the outside changes of object.
/// - Don't want to read from cached object metadata.
/// - No repeated stat call will be sent to the same object.
///
/// You may want to use `metadata`, if you:
///
/// - Are working with objects returned by [`ObjectLister`]. It's highly possible that metadata you want has already been cached.
/// - Are working with the same object instance.
/// You may want to use `metadata` if you are working with objects
/// returned by [`ObjectLister`]. It's highly possible that metadata
/// you want has already been cached.
///
/// # Examples
///
Expand Down Expand Up @@ -1161,12 +1159,10 @@ impl Object {
///
/// - Want detect the outside changes of object.
/// - Don't want to read from cached object metadata.
/// - No repeated stat call will be sent to the same object.
///
/// You may want to use `metadata`, if you:
///
/// - Are working with objects returned by [`ObjectLister`]. It's highly possible that metadata you want has already been cached.
/// - Are working with the same object instance.
/// You may want to use `metadata` if you are working with objects
/// returned by [`ObjectLister`]. It's highly possible that metadata
/// you want has already been cached.
///
/// # Examples
///
Expand Down Expand Up @@ -1199,16 +1195,14 @@ impl Object {
///
/// # Notes
///
/// Use `metadata` if you:
///
/// - Are working with objects returned by [`ObjectLister`]. It's highly possible that metadata you want has already been cached.
/// - Are working with the same object instance.
/// Use `metadata` if you are working with objects returned by
/// [`ObjectLister`]. It's highly possible that metadata you want
/// has already been cached.
///
/// You may want to use `stat`, if you:
///
/// - Want detect the outside changes of object.
/// - Don't want to read from cached object metadata.
/// - No repeated stat call will be sent to the same object.
///
/// # Behavior
///
Expand Down Expand Up @@ -1303,16 +1297,14 @@ impl Object {
///
/// # Notes
///
/// Use `metadata` if you:
///
/// - Are working with objects returned by [`ObjectLister`]. It's highly possible that metadata you want has already been cached.
/// - Are working with the same object instance.
/// Use `metadata` if you are working with objects returned by
/// [`ObjectLister`]. It's highly possible that metadata you want
/// has already been cached.
///
/// You may want to use `stat`, if you:
///
/// - Want detect the outside changes of object.
/// - Don't want to read from cached object metadata.
/// - No repeated stat call will be sent to the same object.
///
/// # Behavior
///
Expand Down