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