A context for filling entries (data) into clusters of an RNTuple.

An output cluster can be filled with entries. The caller has to make sure that the data that gets filled into a cluster 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 FlushCluster() or by destructing the context. On I/O errors, an exception is thrown.

Instances of this class are not meant to be used in isolation and can be created from an RNTupleParallelWriter. For sequential writing, please refer to RNTupleWriter.

Definition at line 51 of file RNTupleFillContext.hxx.

Public Member Functions
	~RNTupleFillContext ()

void	CommitStagedClusters ()
	Logically append staged clusters to the RNTuple.

std::unique_ptr< REntry >	CreateEntry ()

void	EnableMetrics ()

void	EnableStagedClusterCommitting (bool val=true)

std::size_t	Fill (REntry &entry)
	Fill an entry into this context.

void	FillNoFlush (REntry &entry, RNTupleFillStatus &status)
	Fill an entry into this context, but don't commit the cluster.

void	FlushCluster ()
	Flush so far filled entries to storage.

void	FlushColumns ()
	Flush column data, preparing for CommitCluster or to reduce memory usage.

NTupleSize_t	GetLastFlushed () const
	Return the entry number that was last flushed in a cluster.

const Detail::RNTupleMetrics &	GetMetrics () const

const RNTupleModel &	GetModel () const

NTupleSize_t	GetNEntries () const
	Return the number of entries filled so far.

bool	IsStagedClusterCommittingEnabled () const

Private Member Functions
	RNTupleFillContext (const RNTupleFillContext &)=delete

	RNTupleFillContext (std::unique_ptr< RNTupleModel > model, std::unique_ptr< Internal::RPageSink > sink)

RNTupleFillContext &	operator= (const RNTupleFillContext &)=delete

Private Attributes
NTupleSize_t	fLastFlushed = 0

std::size_t	fMaxUnzippedClusterSize
	Limit for committing cluster no matter the other tunables.

Detail::RNTupleMetrics	fMetrics

std::unique_ptr< RNTupleModel >	fModel
	Needs to be destructed before fSink.

std::uint64_t	fNBytesFilled = 0
	The total number of bytes filled into all the so far committed clusters, i.e.

std::uint64_t	fNBytesFlushed = 0
	The total number of bytes written to storage (i.e., after compression)

NTupleSize_t	fNEntries = 0

std::unique_ptr< Internal::RPageSink >	fSink

bool	fStagedClusterCommitting = false
	Whether to enable staged cluster committing, where only an explicit call to CommitStagedClusters() will logically append the clusters to the RNTuple.

std::vector< Internal::RPageSink::RStagedCluster >	fStagedClusters
	Vector of currently staged clusters.

std::size_t	fUnzippedClusterSize = 0
	Keeps track of the number of bytes written into the current cluster.

std::size_t	fUnzippedClusterSizeEst
	Estimator of uncompressed cluster size, taking into account the estimated compression ratio.

Friends
class	RNTupleParallelWriter

class	RNTupleWriter

#include <ROOT/RNTupleFillContext.hxx>

Constructor & Destructor Documentation

◆ RNTupleFillContext() [1/2]

ROOT::Experimental::RNTupleFillContext::RNTupleFillContext	(	std::unique_ptr< RNTupleModel >	model,
		std::unique_ptr< Internal::RPageSink >	sink
	)

private

Definition at line 29 of file RNTupleFillContext.cxx.

◆ RNTupleFillContext() [2/2]

ROOT::Experimental::RNTupleFillContext::RNTupleFillContext ( const RNTupleFillContext & )

privatedelete

◆ ~RNTupleFillContext()

ROOT::Experimental::RNTupleFillContext::~RNTupleFillContext ( )

Definition at line 44 of file RNTupleFillContext.cxx.

Member Function Documentation

◆ CommitStagedClusters()

void ROOT::Experimental::RNTupleFillContext::CommitStagedClusters ( )

Logically append staged clusters to the RNTuple.

Definition at line 93 of file RNTupleFillContext.cxx.

◆ CreateEntry()

std::unique_ptr< REntry > ROOT::Experimental::RNTupleFillContext::CreateEntry ( )

inline

Definition at line 128 of file RNTupleFillContext.hxx.

◆ EnableMetrics()

void ROOT::Experimental::RNTupleFillContext::EnableMetrics ( )

inline

Definition at line 144 of file RNTupleFillContext.hxx.

◆ EnableStagedClusterCommitting()

void ROOT::Experimental::RNTupleFillContext::EnableStagedClusterCommitting ( bool val = true )

inline

Definition at line 135 of file RNTupleFillContext.hxx.

◆ Fill()

std::size_t ROOT::Experimental::RNTupleFillContext::Fill ( REntry & entry )

inline

Fill an entry into this context.

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

Returns: The number of uncompressed bytes written.

Definition at line 111 of file RNTupleFillContext.hxx.

◆ FillNoFlush()

void ROOT::Experimental::RNTupleFillContext::FillNoFlush	(	REntry &	entry,
		RNTupleFillStatus &	status
	)

inline

Fill an entry into this context, but don't commit the cluster.

The calling code must pass an RNTupleFillStatus and check RNTupleFillStatus::ShouldFlushCluster.

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

Definition at line 93 of file RNTupleFillContext.hxx.

◆ FlushCluster()

void ROOT::Experimental::RNTupleFillContext::FlushCluster ( )

Flush so far filled entries to storage.

Definition at line 65 of file RNTupleFillContext.cxx.

◆ FlushColumns()

void ROOT::Experimental::RNTupleFillContext::FlushColumns ( )

Flush column data, preparing for CommitCluster or to reduce memory usage.

This will trigger compression of pages, but not actually write to storage.

Definition at line 58 of file RNTupleFillContext.cxx.

◆ GetLastFlushed()

NTupleSize_t ROOT::Experimental::RNTupleFillContext::GetLastFlushed ( ) const

inline

Return the entry number that was last flushed in a cluster.

Definition at line 131 of file RNTupleFillContext.hxx.

◆ GetMetrics()

const Detail::RNTupleMetrics & ROOT::Experimental::RNTupleFillContext::GetMetrics ( ) const

inline

Definition at line 145 of file RNTupleFillContext.hxx.

◆ GetModel()

const RNTupleModel & ROOT::Experimental::RNTupleFillContext::GetModel ( ) const

inline

Definition at line 127 of file RNTupleFillContext.hxx.

◆ GetNEntries()

NTupleSize_t ROOT::Experimental::RNTupleFillContext::GetNEntries ( ) const

inline

Return the number of entries filled so far.

Definition at line 133 of file RNTupleFillContext.hxx.

◆ IsStagedClusterCommittingEnabled()

bool ROOT::Experimental::RNTupleFillContext::IsStagedClusterCommittingEnabled ( ) const

inline

Definition at line 142 of file RNTupleFillContext.hxx.

◆ operator=()

RNTupleFillContext & ROOT::Experimental::RNTupleFillContext::operator= ( const RNTupleFillContext & )

privatedelete

Friends And Related Symbol Documentation

◆ RNTupleParallelWriter

friend class RNTupleParallelWriter

friend

Definition at line 53 of file RNTupleFillContext.hxx.

◆ RNTupleWriter

friend class RNTupleWriter

friend

Definition at line 52 of file RNTupleFillContext.hxx.

Member Data Documentation

◆ fLastFlushed

NTupleSize_t ROOT::Experimental::RNTupleFillContext::fLastFlushed = 0

private

Definition at line 62 of file RNTupleFillContext.hxx.

◆ fMaxUnzippedClusterSize

std::size_t ROOT::Experimental::RNTupleFillContext::fMaxUnzippedClusterSize

private

Limit for committing cluster no matter the other tunables.

Definition at line 72 of file RNTupleFillContext.hxx.

◆ fMetrics

Detail::RNTupleMetrics ROOT::Experimental::RNTupleFillContext::fMetrics

private

Definition at line 60 of file RNTupleFillContext.hxx.

◆ fModel

std::unique_ptr<RNTupleModel> ROOT::Experimental::RNTupleFillContext::fModel

private

Needs to be destructed before fSink.

Definition at line 58 of file RNTupleFillContext.hxx.

◆ fNBytesFilled

std::uint64_t ROOT::Experimental::RNTupleFillContext::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 70 of file RNTupleFillContext.hxx.

◆ fNBytesFlushed

std::uint64_t ROOT::Experimental::RNTupleFillContext::fNBytesFlushed = 0

private

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

Definition at line 67 of file RNTupleFillContext.hxx.

◆ fNEntries

NTupleSize_t ROOT::Experimental::RNTupleFillContext::fNEntries = 0

private

Definition at line 63 of file RNTupleFillContext.hxx.

◆ fSink

std::unique_ptr<Internal::RPageSink> ROOT::Experimental::RNTupleFillContext::fSink

private

Definition at line 56 of file RNTupleFillContext.hxx.

◆ fStagedClusterCommitting

bool ROOT::Experimental::RNTupleFillContext::fStagedClusterCommitting = false

private

Whether to enable staged cluster committing, where only an explicit call to CommitStagedClusters() will logically append the clusters to the RNTuple.

Definition at line 78 of file RNTupleFillContext.hxx.

◆ fStagedClusters

std::vector<Internal::RPageSink::RStagedCluster> ROOT::Experimental::RNTupleFillContext::fStagedClusters

private

Vector of currently staged clusters.

Definition at line 80 of file RNTupleFillContext.hxx.

◆ fUnzippedClusterSize

std::size_t ROOT::Experimental::RNTupleFillContext::fUnzippedClusterSize = 0

private

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

Definition at line 65 of file RNTupleFillContext.hxx.

◆ fUnzippedClusterSizeEst

std::size_t ROOT::Experimental::RNTupleFillContext::fUnzippedClusterSizeEst

private

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

Definition at line 74 of file RNTupleFillContext.hxx.

Libraries for ROOT::Experimental::RNTupleFillContext:

[legend]

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

tree/ntuple/v7/inc/ROOT/RNTupleFillContext.hxx
tree/ntuple/v7/src/RNTupleFillContext.cxx

Public Member Functions

Private Member Functions

Private Attributes

Friends

Constructor & Destructor Documentation

◆ RNTupleFillContext() [1/2]

◆ RNTupleFillContext() [2/2]

◆ ~RNTupleFillContext()

Member Function Documentation

◆ CommitStagedClusters()

◆ CreateEntry()

◆ EnableMetrics()

◆ EnableStagedClusterCommitting()

◆ Fill()

◆ FillNoFlush()

◆ FlushCluster()

◆ FlushColumns()

◆ GetLastFlushed()

◆ GetMetrics()

◆ GetModel()

◆ GetNEntries()

◆ IsStagedClusterCommittingEnabled()

◆ operator=()

Friends And Related Symbol Documentation

◆ RNTupleParallelWriter

◆ RNTupleWriter

Member Data Documentation

◆ fLastFlushed

◆ fMaxUnzippedClusterSize

◆ fMetrics

◆ fModel

◆ fNBytesFilled

◆ fNBytesFlushed

◆ fNEntries

◆ fSink

◆ fStagedClusterCommitting

◆ fStagedClusters

◆ fUnzippedClusterSize

◆ fUnzippedClusterSizeEst