ROOT::Experimental::Detail::RPageStorage Class Reference

Common functionality of an ntuple storage for both reading and writing.

The RPageStore provides access to a storage container that keeps the bits of pages and clusters comprising an ntuple. Concrete implementations can use a TFile, a raw file, an object store, and so on.

Definition at line 61 of file RPageStorage.hxx.

Classes
struct	RColumnHandle
class	RTaskScheduler
	The interface of a task scheduler to schedule page (de)compression tasks. More...

Public Types
using	ColumnHandle_t = RColumnHandle
	The column handle identifies a column with the current open page storage.

Public Member Functions
	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.
virtual void	DropColumn (ColumnHandle_t columnHandle)=0
	Unregisters a column.
virtual RNTupleMetrics &	GetMetrics ()
	Returns an empty metrics. Page storage implementations usually have their own metrics.
virtual EPageStorageType	GetType ()=0
	Whether the concrete implementation is a sink or a source.
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.
void	SetTaskScheduler (RTaskScheduler *taskScheduler)

Protected Attributes
std::string	fNTupleName
RTaskScheduler *	fTaskScheduler = nullptr

#include <ROOT/RPageStorage.hxx>

Inheritance diagram for ROOT::Experimental::Detail::RPageStorage:

Member Typedef Documentation

ColumnHandle_t

using ROOT::Experimental::Detail::RPageStorage::ColumnHandle_t = RColumnHandle

The column handle identifies a column with the current open page storage.

Definition at line 99 of file RPageStorage.hxx.

Constructor & Destructor Documentation

RPageStorage() [1/3]

ROOT::Experimental::Detail::RPageStorage::RPageStorage ( std::string_view  name )

explicit

Definition at line 34 of file RPageStorage.cxx.

RPageStorage() [2/3]

ROOT::Experimental::Detail::RPageStorage::RPageStorage ( const RPageStorage &  other )

delete

RPageStorage() [3/3]

ROOT::Experimental::Detail::RPageStorage::RPageStorage ( RPageStorage &&  other )

default

~RPageStorage()

ROOT::Experimental::Detail::RPageStorage::~RPageStorage ( )

virtual

Definition at line 38 of file RPageStorage.cxx.

Member Function Documentation

AddColumn()

virtual ColumnHandle_t ROOT::Experimental::Detail::RPageStorage::AddColumn ( DescriptorId_t  fieldId, const RColumn &  column  )

pure virtual

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.

Implemented in ROOT::Experimental::Detail::RPageSink, and ROOT::Experimental::Detail::RPageSource.

DropColumn()

virtual void ROOT::Experimental::Detail::RPageStorage::DropColumn ( ColumnHandle_t  columnHandle )

pure virtual

Unregisters a column.

A page source decreases the reference counter for the corresponding active column. For a page sink, dropping columns is currently a no-op.

Implemented in ROOT::Experimental::Detail::RPageSource, and ROOT::Experimental::Detail::RPageSink.

GetMetrics()

ROOT::Experimental::Detail::RNTupleMetrics & ROOT::Experimental::Detail::RPageStorage::GetMetrics ( )

virtual

Returns an empty metrics. Page storage implementations usually have their own metrics.

Reimplemented in ROOT::Experimental::Detail::RPageSinkFile, and ROOT::Experimental::Detail::RPageSourceFile.

Definition at line 42 of file RPageStorage.cxx.

GetType()

virtual EPageStorageType ROOT::Experimental::Detail::RPageStorage::GetType ( )

pure virtual

Whether the concrete implementation is a sink or a source.

Implemented in ROOT::Experimental::Detail::RPageSink, and ROOT::Experimental::Detail::RPageSource.

operator=() [1/2]

RPageStorage & ROOT::Experimental::Detail::RPageStorage::operator= ( const RPageStorage &  other )

delete

operator=() [2/2]

RPageStorage & ROOT::Experimental::Detail::RPageStorage::operator= ( RPageStorage &&  other )

default

ReleasePage()

virtual void ROOT::Experimental::Detail::RPageStorage::ReleasePage ( RPage &  page )

pure virtual

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

But Sinks and sources have different means of allocating pages.

Implemented in ROOT::Experimental::Detail::RPageSinkFile, and ROOT::Experimental::Detail::RPageSourceFile.

SetTaskScheduler()

void ROOT::Experimental::Detail::RPageStorage::SetTaskScheduler ( RTaskScheduler *  taskScheduler )

inline

Definition at line 115 of file RPageStorage.hxx.

Member Data Documentation

fNTupleName

std::string ROOT::Experimental::Detail::RPageStorage::fNTupleName

protected

Definition at line 76 of file RPageStorage.hxx.

fTaskScheduler

RTaskScheduler* ROOT::Experimental::Detail::RPageStorage::fTaskScheduler = nullptr

protected

Definition at line 77 of file RPageStorage.hxx.

Libraries for ROOT::Experimental::Detail::RPageStorage:

---

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

• tree/ntuple/v7/inc/ROOT/RPageStorage.hxx
• tree/ntuple/v7/src/RPageStorage.cxx