OmniSciDB  2e3a973ef4
foreign_storage::ForeignDataWrapper Class Referenceabstract

#include <ForeignDataWrapper.h>

+ Inheritance diagram for foreign_storage::ForeignDataWrapper:

Public Member Functions

 ForeignDataWrapper ()=default
 
virtual ~ForeignDataWrapper ()=default
 
virtual void populateChunkMetadata (ChunkMetadataVector &chunk_metadata_vector)=0
 
virtual void populateChunkBuffers (std::map< ChunkKey, AbstractBuffer *> &required_buffers, std::map< ChunkKey, AbstractBuffer *> &optional_buffers)=0
 
virtual void serializeDataWrapperInternals (const std::string &file_path) const =0
 
virtual void restoreDataWrapperInternals (const std::string &file_path, const ChunkMetadataVector &chunk_metadata)=0
 
virtual bool isRestored () const =0
 

Detailed Description

Definition at line 26 of file ForeignDataWrapper.h.

Constructor & Destructor Documentation

◆ ForeignDataWrapper()

foreign_storage::ForeignDataWrapper::ForeignDataWrapper ( )
default

◆ ~ForeignDataWrapper()

virtual foreign_storage::ForeignDataWrapper::~ForeignDataWrapper ( )
virtualdefault

Member Function Documentation

◆ isRestored()

virtual bool foreign_storage::ForeignDataWrapper::isRestored ( ) const
pure virtual

◆ populateChunkBuffers()

virtual void foreign_storage::ForeignDataWrapper::populateChunkBuffers ( std::map< ChunkKey, AbstractBuffer *> &  required_buffers,
std::map< ChunkKey, AbstractBuffer *> &  optional_buffers 
)
pure virtual

Populates given chunk buffers identified by chunk keys. All provided chunk buffers are expected to be for the same fragment.

Parameters
required_buffers- chunk buffers that must always be populated
optional_buffers- chunk buffers that can be optionally populated, if the data wrapper has to scan through chunk data anyways (typically for row wise data formats)

Implemented in foreign_storage::CsvDataWrapper, and foreign_storage::ParquetDataWrapper.

◆ populateChunkMetadata()

virtual void foreign_storage::ForeignDataWrapper::populateChunkMetadata ( ChunkMetadataVector chunk_metadata_vector)
pure virtual

Populates given chunk metadata vector with metadata for all chunks in related foreign table.

Parameters
chunk_metadata_vector- vector that will be populated with chunk metadata

Implemented in foreign_storage::CsvDataWrapper, and foreign_storage::ParquetDataWrapper.

◆ restoreDataWrapperInternals()

virtual void foreign_storage::ForeignDataWrapper::restoreDataWrapperInternals ( const std::string &  file_path,
const ChunkMetadataVector chunk_metadata 
)
pure virtual

Restore internal state of datawrapper

Parameters
file_path- location of file created by serializeMetadata
chunk_metadata_vector- vector of chunk metadata recovered from disk

Implemented in foreign_storage::CsvDataWrapper, and foreign_storage::ParquetDataWrapper.

◆ serializeDataWrapperInternals()

virtual void foreign_storage::ForeignDataWrapper::serializeDataWrapperInternals ( const std::string &  file_path) const
pure virtual

Serialize internal state of wrapper into file at given path if implemented

Parameters
file_path- location to save file to

Implemented in foreign_storage::CsvDataWrapper, and foreign_storage::ParquetDataWrapper.


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