InternalSystemDataWrapper.h

Go to the documentation of this file.

/*
 * Copyright 2022 HEAVY.AI, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include "ForeignDataWrapper.h"

namespace import_export {
class TypedImportBuffer;
}

namespace foreign_storage {
constexpr const char* kDeletedValueIndicator{"<DELETED>"};

std::string get_db_name(int32_t db_id);
std::string get_table_name(int32_t db_id, int32_t table_id);

void set_node_name(
    std::map<std::string, import_export::TypedImportBuffer*>& import_buffers);

class InternalSystemDataWrapper : public ForeignDataWrapper {
 public:
  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;

 protected:
  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;

  const int db_id_;
  const ForeignTable* foreign_table_;
  size_t row_count_{0};
};
}  // namespace foreign_storage