feat(services/fs): Add user defined metadata support #7061
Merged
+112
−1
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dosubot
bot
added
size:M
zhan7236
force-pushed
the
feat/services-fs-user-metadata
branch
from
50425a7 to
57bf31e
Compare
Xuanwo
reviewed
Dec 19, 2025
core/services/fs/src/core.rs
Outdated
|
|
||
| /// Get user metadata from extended attributes on Unix systems. | ||
| /// | ||
| /// OpenDAL stores user metadata in xattr with the prefix "user.opendal.". |
Member
There was a problem hiding this comment.
Please don't add our own prefix. We should be able to read xattr set by other applications.
core/services/fs/src/core.rs
Outdated
| #[cfg(unix)] | ||
| pub fn set_user_metadata(path: &Path, user_metadata: &HashMap<String, String>) -> Result<()> { | ||
| for (key, value) in user_metadata { | ||
| let attr_name = format!("{}{}", XATTR_PREFIX, key); |
Member
There was a problem hiding this comment.
The same, please don't prefix for users input.
- Add xattr crate dependency for Unix platforms - Enable write_with_user_metadata capability in the fs backend - Implement get_user_metadata() and set_user_metadata() methods using xattr - Update FsWriter to store and write user metadata when closing files - Update fs_stat() to read user metadata from xattr User metadata is stored as extended attributes with the "user." prefix on the filesystem, following the standard Linux xattr naming convention. This allows interoperability with other applications that use xattr.
zhan7236
force-pushed
the
feat/services-fs-user-metadata
branch
from
57bf31e to
7e63eef
Compare
dosubot
bot
added
size:L
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Which issue does this PR close?
Part of #4842.
Rationale for this change
Issue #4842 tracks adding user defined metadata support for various services. This PR implements user metadata support for the
fsservice using extended attributes (xattr) on Unix systems.What changes are included in this PR?
xattrcrate dependency for Unix platformswrite_with_user_metadatacapability in the fs backendget_user_metadata()andset_user_metadata()methods using xattrFsWriterto store and write user metadata when closing filesfs_stat()to read user metadata from xattrUser metadata is stored as extended attributes with the prefix
user.opendal.on the filesystem.Are there any user-facing changes?
Yes. Users can now use
op.write_with("path", data).user_metadata(metadata)to store custom metadata with files on thefsservice (Unix only).AI Usage Statement
This PR was developed with assistance from GitHub Copilot using Claude Opus 4.5.