Logo ROOT  
Reference Guide
 
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Loading...
Searching...
No Matches
RNTupleWriter.cxx
Go to the documentation of this file.
1/// \file RNTupleReader.cxx
2/// \ingroup NTuple ROOT7
3/// \author Jakob Blomer <jblomer@cern.ch>
4/// \date 2024-02-20
5/// \warning This is part of the ROOT 7 prototype! It will change without notice. It might trigger earthquakes. Feedback
6/// is welcome!
7
8/*************************************************************************
9 * Copyright (C) 1995-2024, Rene Brun and Fons Rademakers. *
10 * All rights reserved. *
11 * *
12 * For the licensing terms see $ROOTSYS/LICENSE. *
13 * For the list of contributors see $ROOTSYS/README/CREDITS. *
14 *************************************************************************/
15
17
18#include <ROOT/RLogger.hxx>
22#include <ROOT/RNTupleModel.hxx>
24#include <ROOT/RPageSinkBuf.hxx>
25#include <ROOT/RPageStorage.hxx>
27
28#include <TFile.h>
29#include <TROOT.h>
30
31#include <utility>
32
33ROOT::Experimental::RNTupleWriter::RNTupleWriter(std::unique_ptr<ROOT::Experimental::RNTupleModel> model,
34 std::unique_ptr<ROOT::Experimental::Internal::RPageSink> sink)
35 : fFillContext(std::move(model), std::move(sink)), fMetrics("RNTupleWriter")
36{
37#ifdef R__USE_IMT
38 if (IsImplicitMTEnabled() &&
39 fFillContext.fSink->GetWriteOptions().GetUseImplicitMT() == RNTupleWriteOptions::EImplicitMT::kDefault) {
40 fZipTasks = std::make_unique<Internal::RNTupleImtTaskScheduler>();
41 fFillContext.fSink->SetTaskScheduler(fZipTasks.get());
42 }
43#endif
44 // Observe directly the sink's metrics to avoid an additional prefix from the fill context.
46}
47
49{
50 try {
51 CommitDataset();
52 } catch (const RException &err) {
53 R__LOG_ERROR(ROOT::Internal::NTupleLog()) << "failure committing ntuple: " << err.GetError().GetReport();
54 }
55}
56
57std::unique_ptr<ROOT::Experimental::RNTupleWriter>
58ROOT::Experimental::RNTupleWriter::Create(std::unique_ptr<RNTupleModel> model,
59 std::unique_ptr<Internal::RPageSink> sink, const RNTupleWriteOptions &options)
60{
61 if (model->GetRegisteredSubfields().size() > 0) {
62 throw RException(R__FAIL("cannot create an RNTupleWriter from a model with registered subfields"));
63 }
64 for (const auto &field : model->GetConstFieldZero()) {
65 if (field.GetTraits() & RFieldBase::kTraitEmulatedField)
66 throw RException(
67 R__FAIL("creating a RNTupleWriter from a model containing emulated fields is currently unsupported."));
68 }
69 if (options.GetUseBufferedWrite()) {
70 sink = std::make_unique<Internal::RPageSinkBuf>(std::move(sink));
71 }
72 return std::unique_ptr<RNTupleWriter>(new RNTupleWriter(std::move(model), std::move(sink)));
73}
74
75std::unique_ptr<ROOT::Experimental::RNTupleWriter>
76ROOT::Experimental::RNTupleWriter::Recreate(std::unique_ptr<RNTupleModel> model, std::string_view ntupleName,
77 std::string_view storage, const RNTupleWriteOptions &options)
78{
80 return Create(std::move(model), std::move(sink), options);
81}
82
83std::unique_ptr<ROOT::Experimental::RNTupleWriter>
84ROOT::Experimental::RNTupleWriter::Recreate(std::initializer_list<std::pair<std::string_view, std::string_view>> fields,
85 std::string_view ntupleName, std::string_view storage,
86 const RNTupleWriteOptions &options)
87{
89 auto model = RNTupleModel::Create();
90 for (const auto &fieldDesc : fields) {
91 std::string typeName(fieldDesc.first);
92 std::string fieldName(fieldDesc.second);
93 auto field = RFieldBase::Create(fieldName, typeName);
94 model->AddField(field.Unwrap());
95 }
96 return Create(std::move(model), std::move(sink), options);
97}
98
99std::unique_ptr<ROOT::Experimental::RNTupleWriter>
100ROOT::Experimental::RNTupleWriter::Append(std::unique_ptr<RNTupleModel> model, std::string_view ntupleName,
102{
103 auto file = fileOrDirectory.GetFile();
104 if (!file) {
105 throw RException(R__FAIL("RNTupleWriter only supports writing to a ROOT file. Cannot write into a directory "
106 "that is not backed by a file"));
107 }
108 if (!file->IsBinary()) {
109 throw RException(R__FAIL("RNTupleWriter only supports writing to a ROOT file. Cannot write into " +
110 std::string(file->GetName())));
111 }
112
113 auto sink = std::make_unique<Internal::RPageSinkFile>(ntupleName, fileOrDirectory, options);
114 return Create(std::move(model), std::move(sink), options);
115}
116
118{
119 if (GetNEntries() == fLastCommittedClusterGroup)
120 return;
121 fFillContext.fSink->CommitClusterGroup();
122 fLastCommittedClusterGroup = GetNEntries();
123}
124
126{
127 if (fFillContext.fModel->IsExpired()) {
128 throw RException(R__FAIL("invalid attempt to update expired model"));
129 }
130 return *fFillContext.fModel;
131}
132
134{
135 if (fFillContext.GetModel().IsExpired())
136 return;
137
138 CommitCluster(true /* commitClusterGroup */);
139 fFillContext.fSink->CommitDataset();
140 fFillContext.fModel->Expire();
141}
142
143std::unique_ptr<ROOT::Experimental::RNTupleWriter>
144ROOT::Experimental::Internal::CreateRNTupleWriter(std::unique_ptr<ROOT::Experimental::RNTupleModel> model,
145 std::unique_ptr<ROOT::Experimental::Internal::RPageSink> sink)
146{
147 return std::unique_ptr<ROOT::Experimental::RNTupleWriter>(
148 new ROOT::Experimental::RNTupleWriter(std::move(model), std::move(sink)));
149}
#define R__FAIL(msg)
Short-hand to return an RResult<T> in an error state; the RError is implicitly converted into RResult...
Definition RError.hxx:299
#define R__LOG_ERROR(...)
Definition RLogger.hxx:357
ROOT::Detail::TRangeCast< T, true > TRangeDynCast
TRangeDynCast is an adapter class that allows the typed iteration through a TCollection.
void ObserveMetrics(RNTupleMetrics &observee)
static std::unique_ptr< RPageSink > Create(std::string_view ntupleName, std::string_view location, const RNTupleWriteOptions &options=RNTupleWriteOptions())
Guess the concrete derived page source from the location.
@ kTraitEmulatedField
This field is a user defined type that was missing dictionaries and was reconstructed from the on-dis...
static RResult< std::unique_ptr< RFieldBase > > Create(const std::string &fieldName, const std::string &typeName, const RCreateFieldOptions &options, const RNTupleDescriptor *desc, ROOT::DescriptorId_t fieldId)
Factory method to resurrect a field from the stored on-disk type information.
std::unique_ptr< Internal::RPageSink > fSink
The RNTupleModel encapulates the schema of an ntuple.
static std::unique_ptr< RNTupleModel > Create()
Common user-tunable settings for storing ntuples.
An RNTuple that gets filled with entries (data) and writes them to storage.
RNTupleWriter(std::unique_ptr< RNTupleModel > model, std::unique_ptr< Internal::RPageSink > sink)
static std::unique_ptr< RNTupleWriter > Append(std::unique_ptr< RNTupleModel > model, std::string_view ntupleName, TDirectory &fileOrDirectory, const RNTupleWriteOptions &options=RNTupleWriteOptions())
Throws an exception if the model is null.
std::unique_ptr< Internal::RPageStorage::RTaskScheduler > fZipTasks
The page sink's parallel page compression scheduler if IMT is on.
static std::unique_ptr< RNTupleWriter > Create(std::unique_ptr< RNTupleModel > model, std::unique_ptr< Internal::RPageSink > sink, const RNTupleWriteOptions &options)
Create a writer, potentially wrapping the sink in a RPageSinkBuf.
void CommitDataset()
Closes the underlying file (page sink) and expires the model.
Detail::RNTupleMetrics fMetrics
static std::unique_ptr< RNTupleWriter > Recreate(std::unique_ptr< RNTupleModel > model, std::string_view ntupleName, std::string_view storage, const RNTupleWriteOptions &options=RNTupleWriteOptions())
Throws an exception if the model is null.
Base class for all ROOT issued exceptions.
Definition RError.hxx:79
const RError & GetError() const
Definition RError.hxx:84
Describe directory structure in memory.
Definition TDirectory.h:45
std::unique_ptr< RNTupleWriter > CreateRNTupleWriter(std::unique_ptr< RNTupleModel > model, std::unique_ptr< Internal::RPageSink > sink)
ROOT::RLogChannel & NTupleLog()
Log channel for RNTuple diagnostics.
Bool_t IsImplicitMTEnabled()
Returns true if the implicit multi-threading in ROOT is enabled.
Definition TROOT.cxx:570