Wrapper sink that coalesces cluster column page writes.

TODO(jblomer): The interplay of derived class and RPageSink is not yet optimally designed for page storage wrapper classes like this one. Header and footer serialization, e.g., are done twice. To be revised.

Definition at line 43 of file RPageSinkBuf.hxx.

Classes
class	RColumnBuf
	A buffered column. More...

struct	RCounters
	I/O performance counters that get registered in fMetrics. More...

Public Member Functions
	RPageSinkBuf (const RPageSinkBuf &)=delete

	RPageSinkBuf (RPageSinkBuf &&)=default

	RPageSinkBuf (std::unique_ptr< RPageSink > inner)

	~RPageSinkBuf () override

ColumnHandle_t	AddColumn (DescriptorId_t fieldId, const RColumn &column) final
	Register a new column.

std::uint64_t	CommitCluster (NTupleSize_t nNewEntries) final
	Finalize the current cluster and create a new one for the following data.

void	CommitClusterGroup () final
	Write out the page locations (page list envelope) for all the committed clusters since the last call of CommitClusterGroup (or the beginning of writing).

void	CommitDataset () final
	Finalize the current cluster and the entrire data set.

void	CommitPage (ColumnHandle_t columnHandle, const RPage &page) final
	Write a page to the storage. The column must have been added before.

void	CommitSealedPage (DescriptorId_t physicalColumnId, const RSealedPage &sealedPage) final
	Write a preprocessed page to storage. The column must have been added before.

void	CommitSealedPageV (std::span< RPageStorage::RSealedPageGroup > ranges) final
	Write a vector of preprocessed pages to storage. The corresponding columns must have been added before.

const RNTupleDescriptor &	GetDescriptor () const final
	Return the RNTupleDescriptor being constructed.

void	InitImpl (RNTupleModel &model) final

RPageSinkBuf &	operator= (const RPageSinkBuf &)=delete

RPageSinkBuf &	operator= (RPageSinkBuf &&)=default

void	ReleasePage (RPage &page) final
	Every page store needs to be able to free pages it handed out.

RPage	ReservePage (ColumnHandle_t columnHandle, std::size_t nElements) final
	Get a new, empty page for the given column that can be filled with up to nElements.

void	UpdateSchema (const RNTupleModelChangeset &changeset, NTupleSize_t firstEntry) final
	Incorporate incremental changes to the model into the ntuple descriptor.

Public Member Functions inherited from ROOT::Experimental::Internal::RPageSink
	RPageSink (const RPageSink &)=delete

	RPageSink (RPageSink &&)=default

	RPageSink (std::string_view ntupleName, const RNTupleWriteOptions &options)

	~RPageSink () override

void	DropColumn (ColumnHandle_t) final
	Unregisters a column.

virtual RSinkGuard	GetSinkGuard ()

EPageStorageType	GetType () final
	Whether the concrete implementation is a sink or a source.

const RNTupleWriteOptions &	GetWriteOptions () const
	Returns the sink's write options.

void	Init (RNTupleModel &model)
	Physically creates the storage container to hold the ntuple (e.g., a keys a TFile or an S3 bucket) Init() associates column handles to the columns referenced by the model.

bool	IsInitialized () const

RPageSink &	operator= (const RPageSink &)=delete

RPageSink &	operator= (RPageSink &&)=default

Public Member Functions inherited from ROOT::Experimental::Internal::RPageStorage
	RPageStorage (const RPageStorage &other)=delete

	RPageStorage (RPageStorage &&other)=default

	RPageStorage (std::string_view name)

virtual	~RPageStorage ()

virtual Detail::RNTupleMetrics &	GetMetrics ()
	Returns the default metrics object.

const std::string &	GetNTupleName () const
	Returns the NTuple name.

RPageStorage &	operator= (const RPageStorage &other)=delete

RPageStorage &	operator= (RPageStorage &&other)=default

void	SetTaskScheduler (RTaskScheduler *taskScheduler)

Private Member Functions
void	ConnectFields (const std::vector< RFieldBase * > &fields, NTupleSize_t firstEntry)

Private Attributes
std::vector< RColumnBuf >	fBufferedColumns
	Vector of buffered column pages. Indexed by column id.

std::unique_ptr< RCounters >	fCounters

std::unique_ptr< RNTupleModel >	fInnerModel
	The buffered page sink maintains a copy of the RNTupleModel for the inner sink.

std::unique_ptr< RPageSink >	fInnerSink
	The inner sink, responsible for actually performing I/O.

DescriptorId_t	fNColumns = 0

DescriptorId_t	fNFields = 0

Additional Inherited Members
Public Types inherited from ROOT::Experimental::Internal::RPageStorage
using	ColumnHandle_t = RColumnHandle
	The column handle identifies a column with the current open page storage.

using	SealedPageSequence_t = std::deque< RSealedPage >

Protected Member Functions inherited from ROOT::Experimental::Internal::RPageSink
RSealedPage	SealPage (const RPage &page, const RColumnElementBase &element, int compressionSetting)
	Helper for streaming a page.

Protected Member Functions inherited from ROOT::Experimental::Internal::RPageStorage
void	WaitForAllTasks ()

Static Protected Member Functions inherited from ROOT::Experimental::Internal::RPageSink
static RSealedPage	SealPage (const RPage &page, const RColumnElementBase &element, int compressionSetting, void *buf, bool allowAlias=true)
	Seal a page using the provided buffer.

Protected Attributes inherited from ROOT::Experimental::Internal::RPageSink
std::unique_ptr< RNTupleCompressor >	fCompressor
	Helper to zip pages and header/footer; includes a 16MB (kMAXZIPBUF) zip buffer.

std::unique_ptr< RNTupleWriteOptions >	fOptions

Protected Attributes inherited from ROOT::Experimental::Internal::RPageStorage
Detail::RNTupleMetrics	fMetrics

std::string	fNTupleName

RTaskScheduler *	fTaskScheduler = nullptr

#include <ROOT/RPageSinkBuf.hxx>

Inheritance diagram for ROOT::Experimental::Internal::RPageSinkBuf:

[legend]

Constructor & Destructor Documentation

◆ RPageSinkBuf() [1/3]

ROOT::Experimental::Internal::RPageSinkBuf::RPageSinkBuf ( std::unique_ptr< RPageSink > inner )

explicit

Definition at line 39 of file RPageSinkBuf.cxx.

◆ RPageSinkBuf() [2/3]

ROOT::Experimental::Internal::RPageSinkBuf::RPageSinkBuf ( const RPageSinkBuf & )

delete

◆ RPageSinkBuf() [3/3]

ROOT::Experimental::Internal::RPageSinkBuf::RPageSinkBuf ( RPageSinkBuf && )

default

◆ ~RPageSinkBuf()

ROOT::Experimental::Internal::RPageSinkBuf::~RPageSinkBuf ( )

override

Definition at line 52 of file RPageSinkBuf.cxx.

Member Function Documentation

◆ AddColumn()

ROOT::Experimental::Internal::RPageStorage::ColumnHandle_t ROOT::Experimental::Internal::RPageSinkBuf::AddColumn	(	DescriptorId_t	fieldId,
		const RColumn &	column
	)

finalvirtual

Register a new column.

When reading, the column must exist in the ntuple on disk corresponding to the meta-data. When writing, every column can only be attached once.

Implements ROOT::Experimental::Internal::RPageStorage.

Definition at line 61 of file RPageSinkBuf.cxx.

◆ CommitCluster()

std::uint64_t ROOT::Experimental::Internal::RPageSinkBuf::CommitCluster ( NTupleSize_t nNewEntries )

finalvirtual

Finalize the current cluster and create a new one for the following data.

Returns the number of bytes written to storage (excluding meta-data).

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 180 of file RPageSinkBuf.cxx.

◆ CommitClusterGroup()

void ROOT::Experimental::Internal::RPageSinkBuf::CommitClusterGroup ( )

finalvirtual

Write out the page locations (page list envelope) for all the committed clusters since the last call of CommitClusterGroup (or the beginning of writing).

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 206 of file RPageSinkBuf.cxx.

◆ CommitDataset()

void ROOT::Experimental::Internal::RPageSinkBuf::CommitDataset ( )

finalvirtual

Finalize the current cluster and the entrire data set.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 213 of file RPageSinkBuf.cxx.

◆ CommitPage()

void ROOT::Experimental::Internal::RPageSinkBuf::CommitPage	(	ColumnHandle_t	columnHandle,
		const RPage &	page
	)

finalvirtual

Write a page to the storage. The column must have been added before.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 132 of file RPageSinkBuf.cxx.

◆ CommitSealedPage()

void ROOT::Experimental::Internal::RPageSinkBuf::CommitSealedPage	(	DescriptorId_t	physicalColumnId,
		const RSealedPage &	sealedPage
	)

finalvirtual

Write a preprocessed page to storage. The column must have been added before.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 169 of file RPageSinkBuf.cxx.

◆ CommitSealedPageV()

void ROOT::Experimental::Internal::RPageSinkBuf::CommitSealedPageV ( std::span< RPageStorage::RSealedPageGroup > ranges )

finalvirtual

Write a vector of preprocessed pages to storage. The corresponding columns must have been added before.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 175 of file RPageSinkBuf.cxx.

◆ ConnectFields()

void ROOT::Experimental::Internal::RPageSinkBuf::ConnectFields	(	const std::vector< RFieldBase * > &	fields,
		NTupleSize_t	firstEntry
	)

private

Definition at line 66 of file RPageSinkBuf.cxx.

◆ GetDescriptor()

const ROOT::Experimental::RNTupleDescriptor & ROOT::Experimental::Internal::RPageSinkBuf::GetDescriptor ( ) const

finalvirtual

Return the RNTupleDescriptor being constructed.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 84 of file RPageSinkBuf.cxx.

◆ InitImpl()

void ROOT::Experimental::Internal::RPageSinkBuf::InitImpl ( RNTupleModel & model )

finalvirtual

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 89 of file RPageSinkBuf.cxx.

◆ operator=() [1/2]

RPageSinkBuf & ROOT::Experimental::Internal::RPageSinkBuf::operator= ( const RPageSinkBuf & )

delete

◆ operator=() [2/2]

RPageSinkBuf & ROOT::Experimental::Internal::RPageSinkBuf::operator= ( RPageSinkBuf && )

default

◆ ReleasePage()

void ROOT::Experimental::Internal::RPageSinkBuf::ReleasePage ( RPage & page )

finalvirtual

Every page store needs to be able to free pages it handed out.

But Sinks and sources have different means of allocating pages.

Implements ROOT::Experimental::Internal::RPageStorage.

Definition at line 226 of file RPageSinkBuf.cxx.

◆ ReservePage()

ROOT::Experimental::Internal::RPage ROOT::Experimental::Internal::RPageSinkBuf::ReservePage	(	ColumnHandle_t	columnHandle,
		std::size_t	nElements
	)

finalvirtual

Get a new, empty page for the given column that can be filled with up to nElements.

If nElements is zero, the page sink picks an appropriate size.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 221 of file RPageSinkBuf.cxx.

◆ UpdateSchema()

void ROOT::Experimental::Internal::RPageSinkBuf::UpdateSchema	(	const RNTupleModelChangeset &	changeset,
		NTupleSize_t	firstEntry
	)

finalvirtual

Incorporate incremental changes to the model into the ntuple descriptor.

This happens, e.g. if new fields were added after the initial call to RPageSink::Init(RNTupleModel &). firstEntry specifies the global index for the first stored element in the added columns.

Implements ROOT::Experimental::Internal::RPageSink.

Definition at line 97 of file RPageSinkBuf.cxx.

Member Data Documentation

◆ fBufferedColumns

std::vector<RColumnBuf> ROOT::Experimental::Internal::RPageSinkBuf::fBufferedColumns

private

Vector of buffered column pages. Indexed by column id.

Definition at line 131 of file RPageSinkBuf.hxx.

◆ fCounters

std::unique_ptr<RCounters> ROOT::Experimental::Internal::RPageSinkBuf::fCounters

private

Definition at line 124 of file RPageSinkBuf.hxx.

◆ fInnerModel

std::unique_ptr<RNTupleModel> ROOT::Experimental::Internal::RPageSinkBuf::fInnerModel

private

The buffered page sink maintains a copy of the RNTupleModel for the inner sink.

For the unbuffered case, the RNTupleModel is instead managed by a RNTupleWriter.

Definition at line 129 of file RPageSinkBuf.hxx.

◆ fInnerSink

std::unique_ptr<RPageSink> ROOT::Experimental::Internal::RPageSinkBuf::fInnerSink

private

The inner sink, responsible for actually performing I/O.

Definition at line 126 of file RPageSinkBuf.hxx.

◆ fNColumns

DescriptorId_t ROOT::Experimental::Internal::RPageSinkBuf::fNColumns = 0

private

Definition at line 133 of file RPageSinkBuf.hxx.

◆ fNFields

DescriptorId_t ROOT::Experimental::Internal::RPageSinkBuf::fNFields = 0

private

Definition at line 132 of file RPageSinkBuf.hxx.

Libraries for ROOT::Experimental::Internal::RPageSinkBuf:

[legend]

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

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

Classes

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPageSinkBuf() [1/3]

◆ RPageSinkBuf() [2/3]

◆ RPageSinkBuf() [3/3]

◆ ~RPageSinkBuf()

Member Function Documentation

◆ AddColumn()

◆ CommitCluster()

◆ CommitClusterGroup()

◆ CommitDataset()

◆ CommitPage()

◆ CommitSealedPage()

◆ CommitSealedPageV()

◆ ConnectFields()

◆ GetDescriptor()

◆ InitImpl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReleasePage()

◆ ReservePage()

◆ UpdateSchema()

Member Data Documentation

◆ fBufferedColumns

◆ fCounters

◆ fInnerModel

◆ fInnerSink

◆ fNColumns

◆ fNFields