[df] Add RNTupleWriteOptions to RSnapshotOptions and add format-compatibility checks
#19976
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
N.B., compression settings that have been set directly through the snapshot options are propagated to the RNTuple write options, provided that they haven't been set there as well.
... and warn users when an option has been set that has no effect on the chosen output format.
enirolf
requested review from
jblomer,
martamaja10 and
vepadulano
as code owners
Test Results 21 files 21 suites 3d 13h 43m 27s ⏱️ For more details on these failures, see this check. Results for commit b94a6b8. |
pcanal
reviewed
Sep 25, 2025
Comment on lines
+954
to
+958
| if (opts.fAutoFlush != defaultSnapshotOpts.fAutoFlush) { | ||
| Warning("Snapshot", "The TTree-specific fAutoFlush option in RSnapshotOptions has been set, but the output " | ||
| "format is set to RNTuple, so this option won't have any effect. Use the " | ||
| "fNTupleWriteOptions option available in RSnapshotOptions to configure the output " | ||
| "RNTuple. Alternatively, change fOutputFormat to snapshot to TTree instead."); |
There was a problem hiding this comment.
Consider:
Suggested change
| if (opts.fAutoFlush != defaultSnapshotOpts.fAutoFlush) { | |
| Warning("Snapshot", "The TTree-specific fAutoFlush option in RSnapshotOptions has been set, but the output " | |
| "format is set to RNTuple, so this option won't have any effect. Use the " | |
| "fNTupleWriteOptions option available in RSnapshotOptions to configure the output " | |
| "RNTuple. Alternatively, change fOutputFormat to snapshot to TTree instead."); | |
| const char *issueWith = nullptr; | |
| if (opts.fAutoFlush != defaultSnapshotOpts.fAutoFlush) { | |
| issueWith = "fAutoFlush"; | |
| } else if .... | |
| ... | |
| } | |
| Warning("Snapshot", "The TTree-specific %s option in RSnapshotOptions has been set, but the output " | |
| "format is set to RNTuple, so this option won't have any effect. Use the " | |
| "fNTupleWriteOptions option available in RSnapshotOptions to configure the output " | |
| "RNTuple. Alternatively, change fOutputFormat to snapshot to TTree instead.", issueWith); |
jblomer
approved these changes
Sep 25, 2025
| // compression settings in fNTupleWriteOpts have not been changed, and the compression algorithm or level in fOptions | ||
| // have. | ||
| if (fOptions.fNTupleWriteOpts.GetCompression() == RCompressionSetting::EDefaults::kUseGeneralPurpose && | ||
| (fOptions.fCompressionAlgorithm != RCompressionSetting::EAlgorithm::kZLIB || |
There was a problem hiding this comment.
I think that leaves the possibility that a user explicitly sets fCompression... to what happens to be the current default, but then is surprised because RNTuple doesn't pick it up but continue to use its zstd default. I don't have a good solution though, maybe that's ok.
There was a problem hiding this comment.
Hmm, good point. Perhaps to avoid situations like these it might be better to also warn users for fCompression..., and require them to be set through fNTupleWriteOpts only.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
For snapshotting to RNTuple, users can now pass an
RNTupleWriteOptionstoRSnapshotOptionsto configure the output RNTuple. Compression settings that have been set directly throughRSnapshotOptions::fCompressionAlgorithmandRSnapshotOptions::fCompressionLevelare propagated toRSnapshotOptions::fNTupleWriteOpts, provided that they haven't been set there already as well.In addition, a check has been added to warn users when they set options that are specific to one output format, but
RSnapshotOptions.fOutputFormathas been set to use the other.Closes #19784.