Storage provider that write ntuple pages into a file.

The written file can be either in ROOT format or in RNTuple bare format.

Definition at line 59 of file RPageStorageFile.hxx.

Public Member Functions
	RPageSinkFile (const RPageSinkFile &)=delete

	RPageSinkFile (RPageSinkFile &&)=default

	RPageSinkFile (std::string_view ntupleName, std::string_view path, const RNTupleWriteOptions &options)

	RPageSinkFile (std::string_view ntupleName, std::string_view path, const RNTupleWriteOptions &options, std::unique_ptr< TFile > &file)

	RPageSinkFile (std::string_view ntupleName, TFile &file, const RNTupleWriteOptions &options)

virtual	~RPageSinkFile ()

RPageSinkFile &	operator= (const RPageSinkFile &)=delete

RPageSinkFile &	operator= (RPageSinkFile &&)=default

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

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. More...

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

	RPageSink (RPageSink &&)=default

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

virtual	~RPageSink ()

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

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

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

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

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

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

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

void	Create (RNTupleModel &model)
	Physically creates the storage container to hold the ntuple (e.g., a keys a TFile or an S3 bucket) To do so, Create() calls CreateImpl() after updating the descriptor. More...

void	DropColumn (ColumnHandle_t) final
	Unregisters a column. More...

virtual RNTupleMetrics &	GetMetrics () override
	Returns the default metrics object. Subclasses might alternatively provide their own metrics object by overriding this. More...

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

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

RPageSink &	operator= (const RPageSink &)=delete

RPageSink &	operator= (RPageSink &&)=default

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

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

	RPageStorage (RPageStorage &&other)=default

	RPageStorage (std::string_view name)

virtual	~RPageStorage ()

virtual ColumnHandle_t	AddColumn (DescriptorId_t fieldId, const RColumn &column)=0
	Register a new column. More...

virtual void	DropColumn (ColumnHandle_t columnHandle)=0
	Unregisters a column. More...

virtual RNTupleMetrics &	GetMetrics ()=0
	Page storage implementations have their own metrics. More...

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

virtual EPageStorageType	GetType ()=0
	Whether the concrete implementation is a sink or a source. More...

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

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

virtual void	ReleasePage (RPage &page)=0
	Every page store needs to be able to free pages it handed out. More...

void	SetTaskScheduler (RTaskScheduler *taskScheduler)

Protected Member Functions
RNTupleLocator	CommitClusterGroupImpl (unsigned char *serializedPageList, std::uint32_t length) final
	Returns the locator of the page list envelope of the given buffer that contains the serialized page list. More...

std::uint64_t	CommitClusterImpl (NTupleSize_t nEntries) final
	Returns the number of bytes written to storage (excluding metadata) More...

void	CommitDatasetImpl (unsigned char *serializedFooter, std::uint32_t length) final

RNTupleLocator	CommitPageImpl (ColumnHandle_t columnHandle, const RPage &page) final

RNTupleLocator	CommitSealedPageImpl (DescriptorId_t columnId, const RPageStorage::RSealedPage &sealedPage) final

void	CreateImpl (const RNTupleModel &model, unsigned char *serializedHeader, std::uint32_t length) final

Protected Member Functions inherited from ROOT::Experimental::Detail::RPageSink
virtual RNTupleLocator	CommitClusterGroupImpl (unsigned char *serializedPageList, std::uint32_t length)=0
	Returns the locator of the page list envelope of the given buffer that contains the serialized page list. More...

virtual std::uint64_t	CommitClusterImpl (NTupleSize_t nEntries)=0
	Returns the number of bytes written to storage (excluding metadata) More...

virtual void	CommitDatasetImpl (unsigned char *serializedFooter, std::uint32_t length)=0

virtual RNTupleLocator	CommitPageImpl (ColumnHandle_t columnHandle, const RPage &page)=0

virtual RNTupleLocator	CommitSealedPageImpl (DescriptorId_t columnId, const RPageStorage::RSealedPage &sealedPage)=0

virtual std::vector< RNTupleLocator >	CommitSealedPageVImpl (std::span< RPageStorage::RSealedPageGroup > ranges)
	Vector commit of preprocessed pages. More...

virtual void	CreateImpl (const RNTupleModel &model, unsigned char *serializedHeader, std::uint32_t length)=0

void	EnableDefaultMetrics (const std::string &prefix)
	Enables the default set of metrics provided by RPageSink. More...

RSealedPage	SealPage (const RPage &page, const RColumnElementBase &element, int compressionSetting)
	Helper for streaming a page. More...

Private Member Functions
	RPageSinkFile (std::string_view ntupleName, const RNTupleWriteOptions &options)

RNTupleLocator	WriteSealedPage (const RPageStorage::RSealedPage &sealedPage, std::size_t bytesPacked)

Private Attributes
std::uint64_t	fNBytesCurrentCluster = 0
	Number of bytes committed to storage in the current cluster. More...

std::unique_ptr< RPageAllocatorHeap >	fPageAllocator

std::unique_ptr< Internal::RNTupleFileWriter >	fWriter

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

using	SealedPageSequence_t = std::deque< RSealedPage >

Static Public Member Functions inherited from ROOT::Experimental::Detail::RPageSink
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 file name (location) More...

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

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

std::unique_ptr< RCounters >	fCounters

RNTupleDescriptorBuilder	fDescriptorBuilder

RNTupleMetrics	fMetrics

std::uint64_t	fNextClusterInGroup = 0
	Remembers the starting cluster id for the next cluster group. More...

std::vector< RClusterDescriptor::RColumnRange >	fOpenColumnRanges
	Keeps track of the number of elements in the currently open cluster. Indexed by column id. More...

std::vector< RClusterDescriptor::RPageRange >	fOpenPageRanges
	Keeps track of the written pages in the currently open cluster. Indexed by column id. More...

std::unique_ptr< RNTupleWriteOptions >	fOptions

NTupleSize_t	fPrevClusterNEntries = 0
	Used to calculate the number of entries in the current cluster. More...

Protected Attributes inherited from ROOT::Experimental::Detail::RPageStorage
std::string	fNTupleName

RTaskScheduler *	fTaskScheduler = nullptr

#include <ROOT/RPageStorageFile.hxx>

Inheritance diagram for ROOT::Experimental::Detail::RPageSinkFile:

[legend]

Constructor & Destructor Documentation

◆ RPageSinkFile() [1/6]

ROOT::Experimental::Detail::RPageSinkFile::RPageSinkFile	(	std::string_view	ntupleName,
		const RNTupleWriteOptions &	options
	)

private

Definition at line 46 of file RPageStorageFile.cxx.

◆ RPageSinkFile() [2/6]

ROOT::Experimental::Detail::RPageSinkFile::RPageSinkFile	(	std::string_view	ntupleName,
		std::string_view	path,
		const RNTupleWriteOptions &	options
	)

Definition at line 58 of file RPageStorageFile.cxx.

◆ RPageSinkFile() [3/6]

ROOT::Experimental::Detail::RPageSinkFile::RPageSinkFile	(	std::string_view	ntupleName,
		std::string_view	path,
		const RNTupleWriteOptions &	options,
		std::unique_ptr< TFile > &	file
	)

Definition at line 75 of file RPageStorageFile.cxx.

◆ RPageSinkFile() [4/6]

ROOT::Experimental::Detail::RPageSinkFile::RPageSinkFile	(	std::string_view	ntupleName,
		TFile &	file,
		const RNTupleWriteOptions &	options
	)

Definition at line 67 of file RPageStorageFile.cxx.

◆ RPageSinkFile() [5/6]

ROOT::Experimental::Detail::RPageSinkFile::RPageSinkFile ( const RPageSinkFile & )

delete

◆ RPageSinkFile() [6/6]

ROOT::Experimental::Detail::RPageSinkFile::RPageSinkFile ( RPageSinkFile && )

default

◆ ~RPageSinkFile()

ROOT::Experimental::Detail::RPageSinkFile::~RPageSinkFile ( )

virtual

Definition at line 84 of file RPageStorageFile.cxx.

Member Function Documentation

◆ CommitClusterGroupImpl()

ROOT::Experimental::RNTupleLocator ROOT::Experimental::Detail::RPageSinkFile::CommitClusterGroupImpl	(	unsigned char *	serializedPageList,
		std::uint32_t	length
	)

finalprotectedvirtual

Returns the locator of the page list envelope of the given buffer that contains the serialized page list.

Typically, the implementation takes care of compressing and writing the provided buffer.

Implements ROOT::Experimental::Detail::RPageSink.

Definition at line 154 of file RPageStorageFile.cxx.

◆ CommitClusterImpl()

std::uint64_t ROOT::Experimental::Detail::RPageSinkFile::CommitClusterImpl ( NTupleSize_t nEntries )

finalprotectedvirtual

Returns the number of bytes written to storage (excluding metadata)

Implements ROOT::Experimental::Detail::RPageSink.

Definition at line 146 of file RPageStorageFile.cxx.

◆ CommitDatasetImpl()

void ROOT::Experimental::Detail::RPageSinkFile::CommitDatasetImpl	(	unsigned char *	serializedFooter,
		std::uint32_t	length
	)

finalprotectedvirtual

Implements ROOT::Experimental::Detail::RPageSink.

Definition at line 167 of file RPageStorageFile.cxx.

◆ CommitPageImpl()

ROOT::Experimental::RNTupleLocator ROOT::Experimental::Detail::RPageSinkFile::CommitPageImpl	(	ColumnHandle_t	columnHandle,
		const RPage &	page
	)

finalprotectedvirtual

Implements ROOT::Experimental::Detail::RPageSink.

Definition at line 119 of file RPageStorageFile.cxx.

◆ CommitSealedPageImpl()

ROOT::Experimental::RNTupleLocator ROOT::Experimental::Detail::RPageSinkFile::CommitSealedPageImpl	(	DescriptorId_t	columnId,
		const RPageStorage::RSealedPage &	sealedPage
	)

finalprotectedvirtual

Implements ROOT::Experimental::Detail::RPageSink.

Definition at line 134 of file RPageStorageFile.cxx.

◆ CreateImpl()

void ROOT::Experimental::Detail::RPageSinkFile::CreateImpl	(	const RNTupleModel &	model,
		unsigned char *	serializedHeader,
		std::uint32_t	length
	)

finalprotectedvirtual

Implements ROOT::Experimental::Detail::RPageSink.

Definition at line 88 of file RPageStorageFile.cxx.

◆ operator=() [1/2]

RPageSinkFile & ROOT::Experimental::Detail::RPageSinkFile::operator= ( const RPageSinkFile & )

delete

◆ operator=() [2/2]

RPageSinkFile & ROOT::Experimental::Detail::RPageSinkFile::operator= ( RPageSinkFile && )

default

◆ ReleasePage()

void ROOT::Experimental::Detail::RPageSinkFile::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::Detail::RPageStorage.

Definition at line 185 of file RPageStorageFile.cxx.

◆ ReservePage()

ROOT::Experimental::Detail::RPage ROOT::Experimental::Detail::RPageSinkFile::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::Detail::RPageSink.

Definition at line 177 of file RPageStorageFile.cxx.

◆ WriteSealedPage()

ROOT::Experimental::RNTupleLocator ROOT::Experimental::Detail::RPageSinkFile::WriteSealedPage	(	const RPageStorage::RSealedPage &	sealedPage,
		std::size_t	bytesPacked
	)

inlineprivate

Definition at line 99 of file RPageStorageFile.cxx.

Member Data Documentation

◆ fNBytesCurrentCluster

std::uint64_t ROOT::Experimental::Detail::RPageSinkFile::fNBytesCurrentCluster = 0

private

Number of bytes committed to storage in the current cluster.

Definition at line 65 of file RPageStorageFile.hxx.

◆ fPageAllocator

std::unique_ptr<RPageAllocatorHeap> ROOT::Experimental::Detail::RPageSinkFile::fPageAllocator

private

Definition at line 61 of file RPageStorageFile.hxx.

◆ fWriter

std::unique_ptr<Internal::RNTupleFileWriter> ROOT::Experimental::Detail::RPageSinkFile::fWriter

private

Definition at line 63 of file RPageStorageFile.hxx.

Libraries for ROOT::Experimental::Detail::RPageSinkFile:

[legend]

Public Member Functions

Protected Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ RPageSinkFile() [1/6]

◆ RPageSinkFile() [2/6]

◆ RPageSinkFile() [3/6]

◆ RPageSinkFile() [4/6]

◆ RPageSinkFile() [5/6]

◆ RPageSinkFile() [6/6]

◆ ~RPageSinkFile()

Member Function Documentation

◆ CommitClusterGroupImpl()

◆ CommitClusterImpl()

◆ CommitDatasetImpl()

◆ CommitPageImpl()

◆ CommitSealedPageImpl()

◆ CreateImpl()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ ReleasePage()

◆ ReservePage()

◆ WriteSealedPage()

Member Data Documentation

◆ fNBytesCurrentCluster

◆ fPageAllocator

◆ fWriter