Dummy sink that discards all pages.

The RPageNullSink class is for internal testing only and can be used to measure the software overhead of serializing elements into pages, without actually writing them onto disk or even serializing the RNTuple headers and footers.

Definition at line 36 of file RPageNullSink.hxx.

Public Member Functions
	RPageNullSink (std::string_view ntupleName, const RNTupleWriteOptions &options)

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

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	CommitDatasetImpl () final

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

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

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

void	CommitStagedClusters (std::span< RStagedCluster >) final
	Commit staged clusters, logically appending them to the ntuple descriptor.

void	CommitSuppressedColumn (ColumnHandle_t) final
	Commits a suppressed column for the current cluster.

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

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

void	InitImpl (RNTupleModel &model) final

RStagedCluster	StageCluster (NTupleSize_t) final
	Stage the current cluster and create a new one for the following data.

void	UpdateExtraTypeInfo (const RExtraTypeInfoDescriptor &) final
	Adds an extra type information record to schema.

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

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

void	CommitDataset ()
	Run the registered callbacks and finalize the current cluster and the entrire data set.

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

void	RegisterOnCommitDatasetCallback (Callback_t callback)
	The registered callback is executed at the beginning of CommitDataset();.

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

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 ()

ColumnId_t	GetColumnId (ColumnHandle_t columnHandle) const

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 Attributes
std::uint64_t	fNBytesCurrentCluster = 0

DescriptorId_t	fNColumns = 0

Additional Inherited Members
Public Types inherited from ROOT::Experimental::Internal::RPageSink
using	Callback_t = std::function< void(RPageSink &)>

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 >

Static Public Member Functions inherited from ROOT::Experimental::Internal::RPageSink
static RSealedPage	SealPage (const RSealPageConfig &config)
	Seal a page using the provided info.

Static Public Attributes inherited from ROOT::Experimental::Internal::RPageStorage
static constexpr std::size_t	kNBytesPageChecksum = sizeof(std::uint64_t)
	The page checksum is a 64bit xxhash3.

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

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

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

std::unique_ptr< RPageAllocator >	fPageAllocator
	For the time being, we will use the heap allocator for all sources and sinks. This may change in the future.

RTaskScheduler *	fTaskScheduler = nullptr

#include <ROOT/RPageNullSink.hxx>

Inheritance diagram for ROOT::Experimental::Internal::RPageNullSink:

[legend]

Constructor & Destructor Documentation

◆ RPageNullSink()

ROOT::Experimental::Internal::RPageNullSink::RPageNullSink	(	std::string_view	ntupleName,
		const RNTupleWriteOptions &	options
	)

inline

Definition at line 41 of file RPageNullSink.hxx.

Member Function Documentation

◆ AddColumn()

ColumnHandle_t ROOT::Experimental::Internal::RPageNullSink::AddColumn	(	DescriptorId_t	fieldId,
		RColumn &	column
	)

inlinefinalvirtual

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 43 of file RPageNullSink.hxx.

◆ CommitClusterGroup()

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

inlinefinalvirtual

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 95 of file RPageNullSink.hxx.

◆ CommitDatasetImpl()

void ROOT::Experimental::Internal::RPageNullSink::CommitDatasetImpl ( )

inlinefinalvirtual

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

Definition at line 96 of file RPageNullSink.hxx.

◆ CommitPage()

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

inlinefinalvirtual

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

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

Definition at line 73 of file RPageNullSink.hxx.

◆ CommitSealedPage()

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

inlinefinalvirtual

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

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

Definition at line 74 of file RPageNullSink.hxx.

◆ CommitSealedPageV()

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

inlinefinalvirtual

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

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

Definition at line 78 of file RPageNullSink.hxx.

◆ CommitStagedClusters()

void ROOT::Experimental::Internal::RPageNullSink::CommitStagedClusters ( std::span< RStagedCluster > clusters )

inlinefinalvirtual

Commit staged clusters, logically appending them to the ntuple descriptor.

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

Definition at line 94 of file RPageNullSink.hxx.

◆ CommitSuppressedColumn()

void ROOT::Experimental::Internal::RPageNullSink::CommitSuppressedColumn ( ColumnHandle_t columnHandle )

inlinefinalvirtual

Commits a suppressed column for the current cluster.

Can be called anytime before CommitCluster(). For any given column and cluster, there must be no calls to both CommitSuppressedColumn() and page commits.

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

Definition at line 72 of file RPageNullSink.hxx.

◆ ConnectFields()

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

inline

Definition at line 51 of file RPageNullSink.hxx.

◆ GetDescriptor()

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

inlinefinalvirtual

Return the RNTupleDescriptor being constructed.

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

Definition at line 45 of file RPageNullSink.hxx.

◆ InitImpl()

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

inlinefinalvirtual

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

Definition at line 61 of file RPageNullSink.hxx.

◆ StageCluster()

RStagedCluster ROOT::Experimental::Internal::RPageNullSink::StageCluster ( NTupleSize_t nNewEntries )

inlinefinalvirtual

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

Returns the object that must be passed to CommitStagedClusters to logically append the staged cluster to the ntuple descriptor.

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

Definition at line 87 of file RPageNullSink.hxx.

◆ UpdateExtraTypeInfo()

void ROOT::Experimental::Internal::RPageNullSink::UpdateExtraTypeInfo ( const RExtraTypeInfoDescriptor & extraTypeInfo )

inlinefinalvirtual

Adds an extra type information record to schema.

The extra type information will be written to the extension header. The information in the record will be merged with the existing information, e.g. duplicate streamer info records will be removed. This method is called by the "on commit dataset" callback registered by specific fields (e.g., streamer field) and during merging.

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

Definition at line 70 of file RPageNullSink.hxx.

◆ UpdateSchema()

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

inlinefinalvirtual

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 66 of file RPageNullSink.hxx.

Member Data Documentation

◆ fNBytesCurrentCluster

std::uint64_t ROOT::Experimental::Internal::RPageNullSink::fNBytesCurrentCluster = 0

private

Definition at line 38 of file RPageNullSink.hxx.

◆ fNColumns

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

private

Definition at line 37 of file RPageNullSink.hxx.

Libraries for ROOT::Experimental::Internal::RPageNullSink:

[legend]

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

tree/ntuple/v7/inc/ROOT/RPageNullSink.hxx

Public Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPageNullSink()

Member Function Documentation

◆ AddColumn()

◆ CommitClusterGroup()

◆ CommitDatasetImpl()

◆ CommitPage()

◆ CommitSealedPage()

◆ CommitSealedPageV()

◆ CommitStagedClusters()

◆ CommitSuppressedColumn()

◆ ConnectFields()

◆ GetDescriptor()

◆ InitImpl()

◆ StageCluster()

◆ UpdateExtraTypeInfo()

◆ UpdateSchema()

Member Data Documentation

◆ fNBytesCurrentCluster

◆ fNColumns