DdlCommandExecutor.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 <string>

// Note: avoid adding #include(s) that require thrift

#include "Catalog/ColumnDescriptor.h"
#include "Catalog/SessionInfo.h"
#include "Catalog/TableDescriptor.h"
#include "QueryEngine/Descriptors/RelAlgExecutionDescriptor.h"
#include "Utils/DdlUtils.h"

// This class should be subclassed to cache additional 'internal' data
//    useful for the implementation, but will avoid being exposed in the header
class DdlCommandData {
 public:
  DdlCommandData(const std::string& ddl_statement) {}
  virtual ~DdlCommandData() {}
  virtual std::string commandStr() = 0;
};

class DdlCommand {
 public:
  DdlCommand(const DdlCommandData& ddl_data,
             std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr)
      : ddl_data_(ddl_data), session_ptr_(session_ptr) {}

  virtual ExecutionResult execute(bool read_only_mode) = 0;

 protected:
  const DdlCommandData& ddl_data_;
  std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr_;
};

class CreateForeignServerCommand : public DdlCommand {
 public:
  CreateForeignServerCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class AlterForeignServerCommand : public DdlCommand {
 public:
  AlterForeignServerCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  void changeForeignServerOwner();
  void renameForeignServer();
  void setForeignServerOptions();
  void setForeignServerDataWrapper();
  bool hasAlterServerPrivileges();
};

class DropForeignServerCommand : public DdlCommand {
 public:
  DropForeignServerCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class CreateForeignTableCommand : public DdlCommand {
 public:
  CreateForeignTableCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  void setTableDetails(const std::string& table_name,
                       TableDescriptor& td,
                       const std::list<ColumnDescriptor>& columns);
  void setColumnDetails(std::list<ColumnDescriptor>& columns);
};

class DropForeignTableCommand : public DdlCommand {
 public:
  DropForeignTableCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);
  ExecutionResult execute(bool read_only_mode) override;
};

class AlterForeignTableCommand : public DdlCommand {
 public:
  AlterForeignTableCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);
  ExecutionResult execute(bool read_only_mode) override;

 private:
  void alterOptions(const foreign_storage::ForeignTable& foreign_table);
  void renameTable(const foreign_storage::ForeignTable* foreign_table);
  void renameColumn(const foreign_storage::ForeignTable* foreign_table);
};

class ShowForeignServersCommand : public DdlCommand {
 public:
  ShowForeignServersCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowCreateServerCommand : public DdlCommand {
 public:
  ShowCreateServerCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  std::string server_;
};

class ShowTablesCommand : public DdlCommand {
 public:
  ShowTablesCommand(const DdlCommandData& ddl_data,
                    std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowTableDetailsCommand : public DdlCommand {
 public:
  ShowTableDetailsCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  std::vector<std::string> getFilteredTableNames();
};

class ShowCreateTableCommand : public DdlCommand {
 public:
  ShowCreateTableCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowDatabasesCommand : public DdlCommand {
 public:
  ShowDatabasesCommand(const DdlCommandData& ddl_data,
                       std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowFunctionsCommand : public DdlCommand {
 public:
  ShowFunctionsCommand(const DdlCommandData& ddl_data,
                       std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowRuntimeFunctionsCommand : public DdlCommand {
 public:
  ShowRuntimeFunctionsCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowTableFunctionsCommand : public DdlCommand {
 public:
  ShowTableFunctionsCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowRuntimeTableFunctionsCommand : public DdlCommand {
 public:
  ShowRuntimeTableFunctionsCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowDiskCacheUsageCommand : public DdlCommand {
 public:
  ShowDiskCacheUsageCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  std::vector<std::string> getFilteredTableNames();
};

class ShowUserDetailsCommand : public DdlCommand {
 public:
  ShowUserDetailsCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowRolesCommand : public DdlCommand {
 public:
  ShowRolesCommand(const DdlCommandData& ddl_data,
                   std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class RefreshForeignTablesCommand : public DdlCommand {
 public:
  RefreshForeignTablesCommand(
      const DdlCommandData& ddl_data,
      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class CreatePolicyCommand : public DdlCommand {
 public:
  CreatePolicyCommand(const DdlCommandData& ddl_data,
                      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class ShowPoliciesCommand : public DdlCommand {
 public:
  ShowPoliciesCommand(const DdlCommandData& ddl_data,
                      std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class DropPolicyCommand : public DdlCommand {
 public:
  DropPolicyCommand(const DdlCommandData& ddl_data,
                    std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;
};

class AlterDatabaseCommand : public DdlCommand {
 public:
  AlterDatabaseCommand(const DdlCommandData& ddl_data,
                       std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  void changeOwner();
  void rename();
};

class ReassignOwnedCommand : public DdlCommand {
 public:
  ReassignOwnedCommand(const DdlCommandData& ddl_data,
                       std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode) override;

 private:
  std::string new_owner_;
  std::set<std::string> old_owners_;
};

enum class ExecutionLocation { ALL_NODES, AGGREGATOR_ONLY, LEAVES_ONLY };
enum class AggregationType { NONE, UNION };

struct DistributedExecutionDetails {
  ExecutionLocation execution_location;
  AggregationType aggregation_type;
};

class DdlCommandExecutor {
 public:
  DdlCommandExecutor(const std::string& ddl_statement,
                     std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr);

  ExecutionResult execute(bool read_only_mode);

  bool isShowUserSessions() const;

  bool isShowQueries() const;

  bool isKillQuery() const;

  bool isAlterSystemClear() const;

  bool isAlterSessionSet() const;

  std::string returnCacheType() const;

  const std::string getTargetQuerySessionToKill() const;

  DistributedExecutionDetails getDistributedExecutionDetails() const;

  const std::string commandStr() const;

  std::pair<std::string, std::string> getSessionParameter() const;

 private:
  std::string ddl_statement_;                 // incoming ddl_statement
  std::string ddl_command_;                   // extracted from ddl_statement_
  std::unique_ptr<DdlCommandData> ddl_data_;  // container for parse data
  std::shared_ptr<Catalog_Namespace::SessionInfo const> session_ptr_;
};