query_optimizer/rules/SwapProbeBuild.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_RULES_SWAP_PROBE_BUILD_HPP_
#define QUICKSTEP_QUERY_OPTIMIZER_RULES_SWAP_PROBE_BUILD_HPP_

#include <memory>
#include <string>

#include "query_optimizer/physical/Physical.hpp"
#include "query_optimizer/rules/Rule.hpp"
#include "query_optimizer/rules/BottomUpRule.hpp"
#include "query_optimizer/cost_model/SimpleCostModel.hpp"
#include "utility/Macros.hpp"

namespace quickstep {
namespace optimizer {

/** \addtogroup OptimizerRules
 *  @{
 */

/**
 * @brief Rule that applies to a physical plan to arrange probe and
 *        build side based on the cardinalities.
 */
class SwapProbeBuild : public BottomUpRule<physical::Physical> {
 public:
  SwapProbeBuild() {
  }

  std::string getName() const override { return "SwapProbeBuild"; }

 protected:
  physical::PhysicalPtr applyToNode(const physical::PhysicalPtr &input) override;
  void init(const physical::PhysicalPtr &input) override;

 private:
  std::unique_ptr<cost::SimpleCostModel> cost_model_;

  DISALLOW_COPY_AND_ASSIGN(SwapProbeBuild);
};

}  // namespace optimizer
}  // namespace quickstep

#endif