Logo ROOT  
Reference Guide
ROOT::Experimental::RNTupleWriter Class Reference

An RNTuple that gets filled with entries (data) and writes them to storage.

An output ntuple can be filled with entries. The caller has to make sure that the data that gets filled into an ntuple is not modified for the time of the Fill() call. The fill call serializes the C++ object into the column format and writes data into the corresponding column page buffers. Writing of the buffers to storage is deferred and can be triggered by Flush() or by destructing the ntuple. On I/O errors, an exception is thrown.

Definition at line 359 of file RNTuple.hxx.

Public Member Functions

 RNTupleWriter (const RNTupleWriter &)=delete
 
 RNTupleWriter (std::unique_ptr< RNTupleModel > model, std::unique_ptr< Detail::RPageSink > sink)
 Throws an exception if the model or the sink is null. More...
 
 ~RNTupleWriter ()
 
void CommitCluster (bool commitClusterGroup=false)
 Ensure that the data from the so far seen Fill calls has been written to storage. More...
 
std::unique_ptr< REntryCreateEntry ()
 
void EnableMetrics ()
 
void Fill ()
 The simplest user interface if the default entry that comes with the ntuple model is used. More...
 
void Fill (REntry &entry)
 Multiple entries can have been instantiated from the ntuple model. More...
 
const Detail::RNTupleMetricsGetMetrics () const
 
const RNTupleModelGetModel () const
 
RNTupleWriteroperator= (const RNTupleWriter &)=delete
 

Static Public Member Functions

static std::unique_ptr< RNTupleWriterAppend (std::unique_ptr< RNTupleModel > model, std::string_view ntupleName, TFile &file, const RNTupleWriteOptions &options=RNTupleWriteOptions())
 Throws an exception if the model is null. More...
 
static std::unique_ptr< RNTupleWriterRecreate (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. More...
 

Private Member Functions

void CommitClusterGroup ()
 

Private Attributes

NTupleSize_t fLastCommitted = 0
 
NTupleSize_t fLastCommittedClusterGroup = 0
 
std::size_t fMaxUnzippedClusterSize
 Limit for committing cluster no matter the other tunables. More...
 
Detail::RNTupleMetrics fMetrics
 
std::unique_ptr< RNTupleModelfModel
 Needs to be destructed before fSink. More...
 
std::uint64_t fNBytesCommitted = 0
 The total number of bytes written to storage (i.e., after compression) More...
 
std::uint64_t fNBytesFilled = 0
 The total number of bytes filled into all the so far committed clusters, i.e. More...
 
NTupleSize_t fNEntries = 0
 
std::unique_ptr< Detail::RPageSinkfSink
 
std::size_t fUnzippedClusterSize = 0
 Keeps track of the number of bytes written into the current cluster. More...
 
NTupleSize_t fUnzippedClusterSizeEst
 Estimator of uncompressed cluster size, taking into account the estimated compression ratio. More...
 
std::unique_ptr< Detail::RPageStorage::RTaskSchedulerfZipTasks
 The page sink's parallel page compression scheduler if IMT is on. More...
 

#include <ROOT/RNTuple.hxx>

Constructor & Destructor Documentation

◆ RNTupleWriter() [1/2]

ROOT::Experimental::RNTupleWriter::RNTupleWriter ( std::unique_ptr< RNTupleModel model,
std::unique_ptr< Detail::RPageSink sink 
)

Throws an exception if the model or the sink is null.

Definition at line 287 of file RNTuple.cxx.

◆ RNTupleWriter() [2/2]

ROOT::Experimental::RNTupleWriter::RNTupleWriter ( const RNTupleWriter )
delete

◆ ~RNTupleWriter()

ROOT::Experimental::RNTupleWriter::~RNTupleWriter ( )

Definition at line 317 of file RNTuple.cxx.

Member Function Documentation

◆ Append()

std::unique_ptr< ROOT::Experimental::RNTupleWriter > ROOT::Experimental::RNTupleWriter::Append ( std::unique_ptr< RNTupleModel model,
std::string_view  ntupleName,
TFile file,
const RNTupleWriteOptions options = RNTupleWriteOptions() 
)
static

Throws an exception if the model is null.

Definition at line 332 of file RNTuple.cxx.

◆ CommitCluster()

void ROOT::Experimental::RNTupleWriter::CommitCluster ( bool  commitClusterGroup = false)

Ensure that the data from the so far seen Fill calls has been written to storage.

Definition at line 354 of file RNTuple.cxx.

◆ CommitClusterGroup()

void ROOT::Experimental::RNTupleWriter::CommitClusterGroup ( )
private

Definition at line 346 of file RNTuple.cxx.

◆ CreateEntry()

std::unique_ptr< REntry > ROOT::Experimental::RNTupleWriter::CreateEntry ( )
inline

Definition at line 421 of file RNTuple.hxx.

◆ EnableMetrics()

void ROOT::Experimental::RNTupleWriter::EnableMetrics ( )
inline

Definition at line 423 of file RNTuple.hxx.

◆ Fill() [1/2]

void ROOT::Experimental::RNTupleWriter::Fill ( )
inline

The simplest user interface if the default entry that comes with the ntuple model is used.

Definition at line 404 of file RNTuple.hxx.

◆ Fill() [2/2]

void ROOT::Experimental::RNTupleWriter::Fill ( REntry entry)
inline

Multiple entries can have been instantiated from the ntuple model.

This method will perform a light check whether the entry comes from the ntuple's own model

Definition at line 407 of file RNTuple.hxx.

◆ GetMetrics()

const Detail::RNTupleMetrics & ROOT::Experimental::RNTupleWriter::GetMetrics ( ) const
inline

Definition at line 424 of file RNTuple.hxx.

◆ GetModel()

const RNTupleModel * ROOT::Experimental::RNTupleWriter::GetModel ( ) const
inline

Definition at line 426 of file RNTuple.hxx.

◆ operator=()

RNTupleWriter & ROOT::Experimental::RNTupleWriter::operator= ( const RNTupleWriter )
delete

◆ Recreate()

std::unique_ptr< ROOT::Experimental::RNTupleWriter > ROOT::Experimental::RNTupleWriter::Recreate ( std::unique_ptr< RNTupleModel model,
std::string_view  ntupleName,
std::string_view  storage,
const RNTupleWriteOptions options = RNTupleWriteOptions() 
)
static

Throws an exception if the model is null.

Definition at line 323 of file RNTuple.cxx.

Member Data Documentation

◆ fLastCommitted

NTupleSize_t ROOT::Experimental::RNTupleWriter::fLastCommitted = 0
private

Definition at line 368 of file RNTuple.hxx.

◆ fLastCommittedClusterGroup

NTupleSize_t ROOT::Experimental::RNTupleWriter::fLastCommittedClusterGroup = 0
private

Definition at line 369 of file RNTuple.hxx.

◆ fMaxUnzippedClusterSize

std::size_t ROOT::Experimental::RNTupleWriter::fMaxUnzippedClusterSize
private

Limit for committing cluster no matter the other tunables.

Definition at line 379 of file RNTuple.hxx.

◆ fMetrics

Detail::RNTupleMetrics ROOT::Experimental::RNTupleWriter::fMetrics
private

Definition at line 367 of file RNTuple.hxx.

◆ fModel

std::unique_ptr<RNTupleModel> ROOT::Experimental::RNTupleWriter::fModel
private

Needs to be destructed before fSink.

Definition at line 366 of file RNTuple.hxx.

◆ fNBytesCommitted

std::uint64_t ROOT::Experimental::RNTupleWriter::fNBytesCommitted = 0
private

The total number of bytes written to storage (i.e., after compression)

Definition at line 374 of file RNTuple.hxx.

◆ fNBytesFilled

std::uint64_t ROOT::Experimental::RNTupleWriter::fNBytesFilled = 0
private

The total number of bytes filled into all the so far committed clusters, i.e.

the uncompressed size of the written clusters

Definition at line 377 of file RNTuple.hxx.

◆ fNEntries

NTupleSize_t ROOT::Experimental::RNTupleWriter::fNEntries = 0
private

Definition at line 370 of file RNTuple.hxx.

◆ fSink

std::unique_ptr<Detail::RPageSink> ROOT::Experimental::RNTupleWriter::fSink
private

Definition at line 364 of file RNTuple.hxx.

◆ fUnzippedClusterSize

std::size_t ROOT::Experimental::RNTupleWriter::fUnzippedClusterSize = 0
private

Keeps track of the number of bytes written into the current cluster.

Definition at line 372 of file RNTuple.hxx.

◆ fUnzippedClusterSizeEst

NTupleSize_t ROOT::Experimental::RNTupleWriter::fUnzippedClusterSizeEst
private

Estimator of uncompressed cluster size, taking into account the estimated compression ratio.

Definition at line 381 of file RNTuple.hxx.

◆ fZipTasks

std::unique_ptr<Detail::RPageStorage::RTaskScheduler> ROOT::Experimental::RNTupleWriter::fZipTasks
private

The page sink's parallel page compression scheduler if IMT is on.

Needs to be destructed after the page sink is destructed and so declared before.

Definition at line 363 of file RNTuple.hxx.

Libraries for ROOT::Experimental::RNTupleWriter:
[legend]

The documentation for this class was generated from the following files: