query_optimizer/logical/SetOperation.hpp

/**
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you 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.
 **/

#ifndef QUICKSTEP_QUERY_OPTIMIZER_LOGICAL_SET_OPERATION_HPP_
#define QUICKSTEP_QUERY_OPTIMIZER_LOGICAL_SET_OPERATION_HPP_

#include <memory>
#include <string>
#include <type_traits>
#include <vector>

#include "query_optimizer/OptimizerTree.hpp"
#include "query_optimizer/expressions/AttributeReference.hpp"
#include "query_optimizer/logical/Logical.hpp"
#include "query_optimizer/logical/LogicalType.hpp"
#include "utility/Cast.hpp"
#include "utility/Macros.hpp"

#include "glog/logging.h"

namespace quickstep {
namespace optimizer {
namespace logical {

/** \addtogroup OptimizerLogical
 *  @{
 */

class SetOperation;
typedef std::shared_ptr<const SetOperation> SetOperationPtr;

/**
 * @brief Base class for logical set operation operator that combines tuples
 *        from two or more relations.
 */
class SetOperation : public Logical {
 public:
  enum SetOperationType {
    kIntersect = 0,
    kUnion,
    kUnionAll
  };

  /**
   * @brief Destructor.
   */
  ~SetOperation() override {}

  LogicalType getLogicalType() const override {
    return LogicalType::kSetOperation;
  }

  std::string getName() const override {
    switch (set_operation_type_) {
      case SetOperationType::kIntersect:
        return "Intersect";
      case SetOperationType::kUnion:
        return "Union";
      case SetOperationType::kUnionAll:
        return "UnionAll";
      default:
        LOG(FATAL) << "Invalid set operation type: "
                   << static_cast<typename std::underlying_type<SetOperationType>::type>(set_operation_type_);
    }
  }

  /**
   * @return The set operation type
   */
  SetOperationType getSetOperationType() const {
    return set_operation_type_;
  }

  /**
   * @return The operands for set operation.
   */
  const std::vector<LogicalPtr>& getOperands() const {
    return operands_;
  }

  std::vector<expressions::AttributeReferencePtr> getOutputAttributes() const override {
    return project_attributes_;
  }

  std::vector<expressions::AttributeReferencePtr> getReferencedAttributes() const override {
    std::vector<expressions::AttributeReferencePtr> referenced_attributes;
    for (const auto &operand : operands_) {
      const std::vector<expressions::AttributeReferencePtr> reference =
          operand->getOutputAttributes();
      referenced_attributes.insert(referenced_attributes.end(),
                                   reference.begin(),
                                   reference.end());
    }
    return referenced_attributes;
  }

  LogicalPtr copyWithNewChildren(
      const std::vector<LogicalPtr> &new_children) const override {
    DCHECK_EQ(new_children.size(), children().size());
    return SetOperation::Create(set_operation_type_, new_children, project_attributes_);
  }

  /**
   * @brief Create a logical set operation operator that combines two or more
   *        relations.
   *
   * @param type The type of set operation.
   * @param operands The operands of the set operation.
   * @param project_attributes The project attributes of this set operation.
   */
  static SetOperationPtr Create(
      const SetOperationType type,
      const std::vector<LogicalPtr> &operands,
      const std::vector<expressions::AttributeReferencePtr> &project_attributes) {
    DCHECK_GT(operands.size(), 1u);
    return SetOperationPtr(new SetOperation(type, operands, project_attributes));
  }

 protected:
  void getFieldStringItems(
      std::vector<std::string> *inline_field_names,
      std::vector<std::string> *inline_field_values,
      std::vector<std::string> *non_container_child_field_names,
      std::vector<OptimizerTreeBaseNodePtr> *non_container_child_fields,
      std::vector<std::string> *container_child_field_names,
      std::vector<std::vector<OptimizerTreeBaseNodePtr>> *container_child_fields) const override {
    inline_field_names->push_back("set_operation_type");
    inline_field_values->push_back(getName());

    container_child_field_names->push_back("operands");
    container_child_fields->push_back(
        CastSharedPtrVector<OptimizerTreeBase>(operands_));

    container_child_field_names->push_back("project_attributes");
    container_child_fields->push_back(
        CastSharedPtrVector<OptimizerTreeBase>(project_attributes_));
  }

 private:
  /**
   * @brief Constructor.
   */
  SetOperation(const SetOperationType set_operation_type,
               const std::vector<LogicalPtr> &operands,
               const std::vector<expressions::AttributeReferencePtr> &project_attributes)
    : set_operation_type_(set_operation_type),
      operands_(operands),
      project_attributes_(project_attributes) {
    for (const LogicalPtr &operand : operands) {
      addChild(operand);
    }
  }

  const SetOperationType set_operation_type_;
  const std::vector<LogicalPtr> operands_;
  const std::vector<expressions::AttributeReferencePtr> project_attributes_;

  DISALLOW_COPY_AND_ASSIGN(SetOperation);
};

/** @} */

}  // namespace logical
}  // namespace optimizer
}  // namespace quickstep

#endif  // QUICKSTEP_QUERY_OPTIMIZER_LOGICAL_SET_OPERATION_HPP_