[ntuple] Add S3 anchor and its tests for S3 backend#22470
Open
JasMehta08 wants to merge 1 commit into
Open
Conversation
JasMehta08
force-pushed
the
ntuple-s3-anchor
branch
from
9a87143 to
3a8cec6
Compare
Contributor
Author
|
I have made the changes so that the build for S3 backend only occurs when curl is present, and removed the s3 flag. |
jblomer
reviewed
Jun 9, 2026
| if the anchor exists, the entire ntuple is complete. | ||
| */ | ||
| // clang-format on | ||
| struct RS3NTupleAnchor { |
Contributor
There was a problem hiding this comment.
Maybe better:
Suggested change
| struct RS3NTupleAnchor { | |
| struct RNTupleAnchorS3 { |
Comment on lines
+53
to
+54
| std::uint32_t fNBytesHeader = 0; | ||
| std::uint32_t fLenHeader = 0; |
Contributor
There was a problem hiding this comment.
Here and for the footer: since we use 64bits in the regular anchor, let's do the same here.
| bool operator==(const RS3NTupleAnchor &other) const; | ||
|
|
||
| /// Serialize the anchor to a JSON string suitable for storage at the base URL | ||
| std::string Serialize() const; |
Contributor
There was a problem hiding this comment.
Suggested change
| std::string Serialize() const; | |
| std::string ToJSON() const; |
| /// Serialize the anchor to a JSON string suitable for storage at the base URL | ||
| std::string Serialize() const; | ||
| /// Deserialize the anchor from a JSON string. Returns an error on malformed or incompatible input. | ||
| RResult<void> Deserialize(const std::string &json); |
Contributor
There was a problem hiding this comment.
Suggested change
| RResult<void> Deserialize(const std::string &json); | |
| RResult<void> FromJSON(const std::string &json); |
Comment on lines
+38
to
+51
| jsonAnchor["anchor_version"] = fVersionAnchor; | ||
| jsonAnchor["format_version_epoch"] = fVersionEpoch; | ||
| jsonAnchor["format_version_major"] = fVersionMajor; | ||
| jsonAnchor["format_version_minor"] = fVersionMinor; | ||
| jsonAnchor["format_version_patch"] = fVersionPatch; | ||
| jsonAnchor["url_template"] = fUrlTemplate; | ||
| jsonAnchor["header_obj_id"] = fHeaderObjId; | ||
| jsonAnchor["header_offset"] = fHeaderOffset; | ||
| jsonAnchor["nbytes_header"] = fNBytesHeader; | ||
| jsonAnchor["len_header"] = fLenHeader; | ||
| jsonAnchor["footer_obj_id"] = fFooterObjId; | ||
| jsonAnchor["footer_offset"] = fFooterOffset; | ||
| jsonAnchor["nbytes_footer"] = fNBytesFooter; | ||
| jsonAnchor["len_footer"] = fLenFooter; |
Contributor
There was a problem hiding this comment.
Maybe, since we use camelCase in the C++ code, let's do the same in JSON.
| if(curl) | ||
| set(ROOTNTuple_EXTRA_HEADERS ${ROOTNTuple_EXTRA_HEADERS} ROOT/RPageStorageS3.hxx) | ||
| target_sources(ROOTNTuple PRIVATE src/RPageStorageS3.cxx) | ||
| target_compile_definitions(ROOTNTuple PRIVATE R__ENABLE_S3) |
Contributor
There was a problem hiding this comment.
Let's wait until we actually need the define.
| /// Serialize the anchor to a JSON string suitable for storage at the base URL | ||
| std::string Serialize() const; | ||
| /// Deserialize the anchor from a JSON string. Returns an error on malformed or incompatible input. | ||
| RResult<void> Deserialize(const std::string &json); |
Contributor
There was a problem hiding this comment.
I think it is easier to make this method static and return a RResult<RS3NTupleAnchor>. Then we don't need to care about object reset.
| // clang-format on | ||
| struct RS3NTupleAnchor { | ||
| /// Allows evolving the anchor JSON schema in future versions | ||
| std::uint32_t fVersionAnchor = 1; |
Contributor
There was a problem hiding this comment.
Not sure if we gain anything by reserving version 0. I think we can just start with it.
Test Results 21 files 21 suites 3d 7h 54m 42s ⏱️ For more details on these failures, see this check. Results for commit 3a8cec6. |
JasMehta08
force-pushed
the
ntuple-s3-anchor
branch
from
3a8cec6 to
77b7180
Compare
JasMehta08
force-pushed
the
ntuple-s3-anchor
branch
from
77b7180 to
7a7616f
Compare
Contributor
Author
|
I have made the update according to the comments |
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
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.
This Pull request:
(Is a part of the GSoC 2026 project
S3 Backend for RNTuple.)Creates the anchor for the S3 backend.
Changes or fixes:
S3NTupleAnchorstruct, using JSON to store the anchor data.ROOT_BUILD_OPTION(s3 OFF "Enable RNTuple support for S3-compatible object storage")to conditionally compile.Checklist: