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, const RColumn &column) final |
Register a new column. | |
std::uint64_t | CommitCluster (NTupleSize_t) 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, 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 | ConnectFields (const std::vector< RFieldBase * > &fields, NTupleSize_t firstEntry) |
const RNTupleDescriptor & | GetDescriptor () const final |
Return the RNTupleDescriptor being constructed. | |
void | InitImpl (RNTupleModel &model) final |
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. | |
![]() | |
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 |
![]() | |
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 Attributes | |
std::uint64_t | fNBytesCurrentCluster = 0 |
DescriptorId_t | fNColumns = 0 |
RPageAllocatorHeap | fPageAllocator {} |
Additional Inherited Members | |
![]() | |
using | ColumnHandle_t = RColumnHandle |
The column handle identifies a column with the current open page storage. | |
using | SealedPageSequence_t = std::deque< RSealedPage > |
![]() | |
RSealedPage | SealPage (const RPage &page, const RColumnElementBase &element, int compressionSetting) |
Helper for streaming a page. | |
![]() | |
void | WaitForAllTasks () |
![]() | |
static RSealedPage | SealPage (const RPage &page, const RColumnElementBase &element, int compressionSetting, void *buf, bool allowAlias=true) |
Seal a page using the provided buffer. | |
![]() | |
std::unique_ptr< RNTupleCompressor > | fCompressor |
Helper to zip pages and header/footer; includes a 16MB (kMAXZIPBUF) zip buffer. | |
std::unique_ptr< RNTupleWriteOptions > | fOptions |
![]() | |
Detail::RNTupleMetrics | fMetrics |
std::string | fNTupleName |
RTaskScheduler * | fTaskScheduler = nullptr |
#include <ROOT/RPageNullSink.hxx>
|
inline |
Definition at line 42 of file RPageNullSink.hxx.
|
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 44 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
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 86 of file RPageNullSink.hxx.
|
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 92 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
Finalize the current cluster and the entrire data set.
Implements ROOT::Experimental::Internal::RPageSink.
Definition at line 93 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
Write a page to the storage. The column must have been added before.
Implements ROOT::Experimental::Internal::RPageSink.
Definition at line 75 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
Write a preprocessed page to storage. The column must have been added before.
Implements ROOT::Experimental::Internal::RPageSink.
Definition at line 76 of file RPageNullSink.hxx.
|
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 77 of file RPageNullSink.hxx.
|
inline |
Definition at line 59 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
Return the RNTupleDescriptor being constructed.
Implements ROOT::Experimental::Internal::RPageSink.
Definition at line 53 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
Implements ROOT::Experimental::Internal::RPageSink.
Definition at line 69 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
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 51 of file RPageNullSink.hxx.
|
inlinefinalvirtual |
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 46 of file RPageNullSink.hxx.
|
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 70 of file RPageNullSink.hxx.
|
private |
Definition at line 39 of file RPageNullSink.hxx.
|
private |
Definition at line 38 of file RPageNullSink.hxx.
|
private |
Definition at line 37 of file RPageNullSink.hxx.