ForeignDataWrapper.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 "DataMgr/ChunkMetadata.h"
#include "ForeignStorageBuffer.h"
#include "Shared/types.h"

#include <map>

struct ColumnDescriptor;
namespace import_export {
class RenderGroupAnalyzer;
}

namespace foreign_storage {
struct ForeignServer;
struct ForeignTable;
struct UserMapping;
using ChunkToBufferMap = std::map<ChunkKey, AbstractBuffer*>;

using RenderGroupAnalyzerMap =
    std::map<int, std::unique_ptr<import_export::RenderGroupAnalyzer>>;

class ForeignDataWrapper {
 public:
  ForeignDataWrapper() = default;
  virtual ~ForeignDataWrapper() = default;

  virtual void populateChunkMetadata(ChunkMetadataVector& chunk_metadata_vector) = 0;

  virtual void populateChunkBuffers(const ChunkToBufferMap& required_buffers,
                                    const ChunkToBufferMap& optional_buffers,
                                    AbstractBuffer* delete_buffer = nullptr) = 0;

  virtual std::string getSerializedDataWrapper() const = 0;

  virtual void restoreDataWrapperInternals(const std::string& file_path,
                                           const ChunkMetadataVector& chunk_metadata) = 0;

  // For testing, is this data wrapper restored from disk
  virtual bool isRestored() const = 0;

  virtual void validateServerOptions(const ForeignServer* foreign_server) const = 0;

  virtual void validateTableOptions(const ForeignTable* foreign_table) const = 0;

  virtual const std::set<std::string_view>& getSupportedTableOptions() const = 0;

  virtual const std::set<std::string> getAlterableTableOptions() const { return {}; };

  virtual void validateUserMappingOptions(const UserMapping* user_mapping,
                                          const ForeignServer* foreign_server) const = 0;

  virtual const std::set<std::string_view>& getSupportedUserMappingOptions() const = 0;

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

  enum ParallelismLevel { NONE, INTRA_FRAGMENT, INTER_FRAGMENT };

  virtual ParallelismLevel getCachedParallelismLevel() const { return NONE; }

  virtual ParallelismLevel getNonCachedParallelismLevel() const { return NONE; }

  virtual void createRenderGroupAnalyzers() {}
};
}  // namespace foreign_storage