#include <InternalSystemDataWrapper.h>

Inheritance diagram for foreign_storage::InternalSystemDataWrapper:

Collaboration diagram for foreign_storage::InternalSystemDataWrapper:

Public Member Functions
	InternalSystemDataWrapper ()

	InternalSystemDataWrapper (const int db_id, const ForeignTable *foreign_table)

void	populateChunkMetadata (ChunkMetadataVector &chunk_metadata_vector) override

void	populateChunkBuffers (const ChunkToBufferMap &required_buffers, const ChunkToBufferMap &optional_buffers, AbstractBuffer *delete_buffer) override

void	validateServerOptions (const ForeignServer *foreign_server) const override

void	validateTableOptions (const ForeignTable *foreign_table) const override

const std::set < std::string_view > &	getSupportedTableOptions () const override

void	validateUserMappingOptions (const UserMapping user_mapping, const ForeignServer foreign_server) const override

const std::set < std::string_view > &	getSupportedUserMappingOptions () const override

std::string	getSerializedDataWrapper () const override

void	restoreDataWrapperInternals (const std::string &file_path, const ChunkMetadataVector &chunk_metadata) override

bool	isRestored () const override

Public Member Functions inherited from foreign_storage::ForeignDataWrapper
	ForeignDataWrapper ()=default

virtual	~ForeignDataWrapper ()=default

virtual const std::set < std::string >	getAlterableTableOptions () const

virtual void	validateSchema (const std::list< ColumnDescriptor > &columns) const

virtual ParallelismLevel	getCachedParallelismLevel () const

virtual ParallelismLevel	getNonCachedParallelismLevel () const

virtual void	createRenderGroupAnalyzers ()
	Create RenderGroupAnalyzers for poly columns. More...

virtual bool	isLazyFragmentFetchingEnabled () const

Protected Member Functions
virtual void	initializeObjectsForTable (const std::string &table_name)=0

virtual void	populateChunkBuffersForTable (const std::string &table_name, std::map< std::string, import_export::TypedImportBuffer * > &import_buffers)=0

Protected Attributes
const int	db_id_

const ForeignTable *	foreign_table_

size_t	row_count_ {0}

Additional Inherited Members
Public Types inherited from foreign_storage::ForeignDataWrapper
enum	ParallelismLevel { NONE, INTRA_FRAGMENT, INTER_FRAGMENT }

Detailed Description

Definition at line 34 of file InternalSystemDataWrapper.h.

Constructor & Destructor Documentation

foreign_storage::InternalSystemDataWrapper::InternalSystemDataWrapper ( )

Definition at line 67 of file InternalSystemDataWrapper.cpp.

68 : db_id_(-1), foreign_table_(nullptr) {}

foreign_storage::InternalSystemDataWrapper::db_id_

const int db_id_

Definition: InternalSystemDataWrapper.h:70

foreign_storage::InternalSystemDataWrapper::foreign_table_

const ForeignTable * foreign_table_

Definition: InternalSystemDataWrapper.h:71

foreign_storage::InternalSystemDataWrapper::InternalSystemDataWrapper	(	const int	db_id,
		const ForeignTable *	foreign_table
	)

Definition at line 70 of file InternalSystemDataWrapper.cpp.

72 : db_id_(db_id), foreign_table_(foreign_table) {}

foreign_storage::InternalSystemDataWrapper::db_id_

const int db_id_

Definition: InternalSystemDataWrapper.h:70

foreign_storage::InternalSystemDataWrapper::foreign_table_

const ForeignTable * foreign_table_

Definition: InternalSystemDataWrapper.h:71

Member Function Documentation

std::string foreign_storage::InternalSystemDataWrapper::getSerializedDataWrapper ( ) const

overridevirtual

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

Implements foreign_storage::ForeignDataWrapper.

Definition at line 226 of file InternalSystemDataWrapper.cpp.

                                                                     {
   return {};
 }

const std::set< std::string_view > & foreign_storage::InternalSystemDataWrapper::getSupportedTableOptions ( ) const

overridevirtual

Gets the set of supported table options for the data wrapper.

Implements foreign_storage::ForeignDataWrapper.

Definition at line 82 of file InternalSystemDataWrapper.cpp.

           {
   static const std::set<std::string_view> supported_table_options{};
   return supported_table_options;
 }

const std::set< std::string_view > & foreign_storage::InternalSystemDataWrapper::getSupportedUserMappingOptions ( ) const

overridevirtual

Gets the set of supported user mapping options for the data wrapper.

Implements foreign_storage::ForeignDataWrapper.

Definition at line 95 of file InternalSystemDataWrapper.cpp.

                                                                 {
   static const std::set<std::string_view> supported_user_mapping_options{};
   return supported_user_mapping_options;
 }

virtual void foreign_storage::InternalSystemDataWrapper::initializeObjectsForTable ( const std::string & table_name )

protectedpure virtual

Implemented in foreign_storage::InternalStorageStatsDataWrapper, foreign_storage::InternalMemoryStatsDataWrapper, and foreign_storage::InternalCatalogDataWrapper.

Referenced by populateChunkMetadata().

Here is the caller graph for this function:

bool foreign_storage::InternalSystemDataWrapper::isRestored ( ) const

overridevirtual

Implements foreign_storage::ForeignDataWrapper.

Definition at line 234 of file InternalSystemDataWrapper.cpp.

                                                  {
   return false;
 }

void foreign_storage::InternalSystemDataWrapper::populateChunkBuffers	(	const ChunkToBufferMap &	required_buffers,
		const ChunkToBufferMap &	optional_buffers,
		AbstractBuffer *	delete_buffer
	)

overridevirtual

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)
delete_buffer	- chunk buffer for fragment's delete column, if non-null data wrapper is expected to mark deleted rows in buffer and continue processing

Implements foreign_storage::ForeignDataWrapper.

Definition at line 186 of file InternalSystemDataWrapper.cpp.

References CHECK, CHECK_EQ, CHUNK_KEY_COLUMN_IDX, CHUNK_KEY_FRAGMENT_IDX, foreign_storage::TextFileBufferParser::convertImportBuffersToDataBlocks(), db_id_, DEBUG_TIMER, foreign_table_, foreign_storage::anonymous_namespace{InternalSystemDataWrapper.cpp}::initialize_chunks(), foreign_storage::anonymous_namespace{InternalSystemDataWrapper.cpp}::initialize_import_buffers(), Catalog_Namespace::SysCatalog::instance(), shared::kInfoSchemaDbName, populateChunkBuffersForTable(), row_count_, and TableDescriptor::tableName.

                                    {
   auto timer = DEBUG_TIMER(__func__);
   CHECK(optional_buffers.empty());
 
   auto& sys_catalog = Catalog_Namespace::SysCatalog::instance();
   auto catalog = sys_catalog.getCatalog(db_id_);
   CHECK(catalog);
   CHECK_EQ(catalog->name(), shared::kInfoSchemaDbName);
 
   auto fragment_id = required_buffers.begin()->first[CHUNK_KEY_FRAGMENT_IDX];
   CHECK_EQ(fragment_id, 0)
       << "In-memory system tables are expected to have a single fragment.";
 
   std::map<ChunkKey, Chunk_NS::Chunk> chunks;
   std::set<const ColumnDescriptor*> columns_to_parse;
   initialize_chunks(
       chunks, required_buffers, row_count_, columns_to_parse, fragment_id, *catalog);
 
   // initialize import buffers from columns.
   std::vector<std::unique_ptr<import_export::TypedImportBuffer>> import_buffers;
   std::map<std::string, import_export::TypedImportBuffer*> import_buffers_map;
   initialize_import_buffers(
       import_buffers, import_buffers_map, columns_to_parse, *catalog);
   populateChunkBuffersForTable(foreign_table_->tableName, import_buffers_map);
 
   auto column_id_to_data_blocks_map =
       TextFileBufferParser::convertImportBuffersToDataBlocks(import_buffers);
   for (auto& [chunk_key, chunk] : chunks) {
     auto data_block_entry =
         column_id_to_data_blocks_map.find(chunk_key[CHUNK_KEY_COLUMN_IDX]);
     CHECK(data_block_entry != column_id_to_data_blocks_map.end());
     chunk.appendData(data_block_entry->second, row_count_, 0);
     chunk.setBuffer(nullptr);
     chunk.setIndexBuffer(nullptr);
   }
 }

Here is the call graph for this function:

virtual void foreign_storage::InternalSystemDataWrapper::populateChunkBuffersForTable	(	const std::string &	table_name,
		std::map< std::string, import_export::TypedImportBuffer * > &	import_buffers
	)

protectedpure virtual

Implemented in foreign_storage::InternalStorageStatsDataWrapper, foreign_storage::InternalMemoryStatsDataWrapper, and foreign_storage::InternalCatalogDataWrapper.

Referenced by populateChunkBuffers().

Here is the caller graph for this function:

void foreign_storage::InternalSystemDataWrapper::populateChunkMetadata ( ChunkMetadataVector & chunk_metadata_vector )

overridevirtual

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

Implements foreign_storage::ForeignDataWrapper.

Definition at line 163 of file InternalSystemDataWrapper.cpp.

References CHECK, CHECK_EQ, db_id_, foreign_table_, foreign_storage::get_placeholder_metadata(), foreign_storage::ForeignTableSchema::getLogicalColumns(), initializeObjectsForTable(), Catalog_Namespace::SysCatalog::instance(), shared::kInfoSchemaDbName, TableDescriptor::maxFragRows, row_count_, TableDescriptor::tableId, and TableDescriptor::tableName.

                                                 {
   auto& sys_catalog = Catalog_Namespace::SysCatalog::instance();
   auto catalog = sys_catalog.getCatalog(db_id_);
   CHECK(catalog);
   CHECK_EQ(catalog->name(), shared::kInfoSchemaDbName);
 
   initializeObjectsForTable(foreign_table_->tableName);
   if (row_count_ > static_cast<size_t>(foreign_table_->maxFragRows)) {
     throw ForeignStorageException{
         "System table size exceeds the maximum supported size."};
   }
   foreign_storage::ForeignTableSchema schema(db_id_, foreign_table_);
   for (auto column : schema.getLogicalColumns()) {
     ChunkKey chunk_key = {db_id_, foreign_table_->tableId, column->columnId, 0};
     if (column->columnType.is_varlen_indeed()) {
       chunk_key.emplace_back(1);
     }
     chunk_metadata_vector.emplace_back(
         chunk_key, get_placeholder_metadata(column->columnType, row_count_));
   }
 }

Here is the call graph for this function:

void foreign_storage::InternalSystemDataWrapper::restoreDataWrapperInternals	(	const std::string &	file_path,
		const ChunkMetadataVector &	chunk_metadata
	)

overridevirtual

Restore internal state of datawrapper

Parameters

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

Implements foreign_storage::ForeignDataWrapper.

Definition at line 230 of file InternalSystemDataWrapper.cpp.

232 {}

void foreign_storage::InternalSystemDataWrapper::validateServerOptions ( const ForeignServer * foreign_server ) const

overridevirtual

Checks that the options for the given foreign server object are valid.

Parameters

foreign_server - foreign server object containing options to be validated

Implements foreign_storage::ForeignDataWrapper.

Definition at line 74 of file InternalSystemDataWrapper.cpp.

References CHECK, and foreign_storage::OptionsContainer::options.

                                                {
   CHECK(foreign_server->options.empty());
 }

void foreign_storage::InternalSystemDataWrapper::validateTableOptions ( const ForeignTable * foreign_table ) const

overridevirtual

Checks that the options for the given foreign table object are valid.

Parameters

foreign_table - foreign table object containing options to be validated

Implements foreign_storage::ForeignDataWrapper.

Definition at line 79 of file InternalSystemDataWrapper.cpp.

80 {}

void foreign_storage::InternalSystemDataWrapper::validateUserMappingOptions	(	const UserMapping *	user_mapping,
		const ForeignServer *	foreign_server
	)		const

overridevirtual

Checks that the options for the given user mapping object are valid.

Parameters

user_mapping - user mapping object containing options to be validated

Implements foreign_storage::ForeignDataWrapper.

Definition at line 88 of file InternalSystemDataWrapper.cpp.

References CHECK, and foreign_storage::UserMapping::options.

                                                {
   CHECK(user_mapping->options.empty());
 }

Member Data Documentation

const int foreign_storage::InternalSystemDataWrapper::db_id_

protected

Definition at line 70 of file InternalSystemDataWrapper.h.

Referenced by populateChunkBuffers(), and populateChunkMetadata().

const ForeignTable* foreign_storage::InternalSystemDataWrapper::foreign_table_

protected

Definition at line 71 of file InternalSystemDataWrapper.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), foreign_storage::InternalMemoryStatsDataWrapper::initializeObjectsForTable(), populateChunkBuffers(), foreign_storage::InternalCatalogDataWrapper::populateChunkBuffersForTable(), foreign_storage::InternalMemoryStatsDataWrapper::populateChunkBuffersForTable(), and populateChunkMetadata().

size_t foreign_storage::InternalSystemDataWrapper::row_count_ {0}

protected

Definition at line 72 of file InternalSystemDataWrapper.h.

Referenced by foreign_storage::InternalCatalogDataWrapper::initializeObjectsForTable(), foreign_storage::InternalMemoryStatsDataWrapper::initializeObjectsForTable(), foreign_storage::InternalStorageStatsDataWrapper::initializeObjectsForTable(), populateChunkBuffers(), and populateChunkMetadata().

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

/home/jenkins-slave/workspace/core-os-doxygen/DataMgr/ForeignStorage/InternalSystemDataWrapper.h
/home/jenkins-slave/workspace/core-os-doxygen/DataMgr/ForeignStorage/InternalSystemDataWrapper.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation