You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@opendal.apache.org by "koushiro (via GitHub)" <gi...@apache.org> on 2024/11/13 02:56:06 UTC
Re: [PR] RFC-5313: Remove Metakey [opendal]
koushiro commented on code in PR #5313:
URL: https://github.com/apache/opendal/pull/5313#discussion_r1839316739
##########
core/src/docs/rfcs/5314_remove_metakey.md:
##########
@@ -0,0 +1,120 @@
+- Proposal Name: `remove_metakey`
+- Start Date: 2024-11-12
+- RFC PR: [apache/opendal#5313](https://github.com/apache/opendal/pull/5313)
+- Tracking Issue: [apache/opendal#5314](https://github.com/apache/opendal/issues/5314)
+
+# Summary
+
+Remove the `Metakey` concept from OpenDAL and replace it with a simpler and more predictable metadata handling mechanism.
+
+# Motivation
+
+The current `Metakey` design has several issues:
+
+1. Performance Impact: Users often unknowingly trigger expensive operations (e.g., using `Metakey::Full` causes additional stat calls)
+2. Usability Issues: Users frequently attempt to access metadata that wasn't explicitly requested
+3. API Confusion: Overlap between `Metakey::Version` and the new `version(bool)` parameter
+4. Implementation Complexity: Service developers find it challenging to implement `Metakey` correctly
Review Comment:
```suggestion
1. Performance Impact: Users often initiate costly operations unintentionally, such as using `Metakey::Full`, which results in extra stat calls.
2. Usability Issues: Users often try to access metadata that hasn't been explicitly requested.
3. API Confusion: There's a conflict between `Metakey::Version` and the new `version(bool)` parameter.
4. Implementation Complexity: Service developers struggle to implement `Metakey` correctly.
```
##########
core/src/docs/rfcs/5314_remove_metakey.md:
##########
@@ -0,0 +1,120 @@
+- Proposal Name: `remove_metakey`
+- Start Date: 2024-11-12
+- RFC PR: [apache/opendal#5313](https://github.com/apache/opendal/pull/5313)
+- Tracking Issue: [apache/opendal#5314](https://github.com/apache/opendal/issues/5314)
+
+# Summary
+
+Remove the `Metakey` concept from OpenDAL and replace it with a simpler and more predictable metadata handling mechanism.
+
+# Motivation
+
+The current `Metakey` design has several issues:
+
+1. Performance Impact: Users often unknowingly trigger expensive operations (e.g., using `Metakey::Full` causes additional stat calls)
+2. Usability Issues: Users frequently attempt to access metadata that wasn't explicitly requested
+3. API Confusion: Overlap between `Metakey::Version` and the new `version(bool)` parameter
+4. Implementation Complexity: Service developers find it challenging to implement `Metakey` correctly
+
+The expected outcome is a simpler, more predictable API that prevents common mistakes and improves performance by default.
Review Comment:
```suggestion
The goal is a simpler, more intuitive API that prevents common mistakes and improves performance as standard.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@opendal.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org