Implement GetInfo for some classes in optimizer and planner (#1463)

yetiancn · tli2 · commit 2406b763b91d · 2018-07-15T20:43:50.000-04:00
diff --git a/src/expression/abstract_expression.cpp b/src/expression/abstract_expression.cpp
@@ -93,9 +93,8 @@ void AbstractExpression::DeduceExpressionName() {
 const std::string AbstractExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1)
-     << "expression type = " << GetExpressionType() << ",\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << GetExpressionType() << "]\n"
      << StringUtil::Indent(num_indent + 1)
      << "value type = " << type::Type::GetInstance(GetValueType())->ToString()
      << ",\n";
diff --git a/src/expression/aggregate_expression.cpp b/src/expression/aggregate_expression.cpp
@@ -17,8 +17,8 @@ namespace expression {
 
 const std::string AggregateExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Aggregate,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Aggregate]\n"
      << StringUtil::Indent(num_indent + 1) << "aggregate type = " << expr_name_
      << std::endl;
   for (const auto &child : children_) {
diff --git a/src/expression/case_expression.cpp b/src/expression/case_expression.cpp
@@ -18,8 +18,8 @@ namespace expression {
 const std::string CaseExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Case,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Case]\n"
      << StringUtil::Indent(num_indent + 1) << "default: \n"
      << default_expr_.get()->GetInfo(num_indent + 2);
 
diff --git a/src/expression/comparison_expression.cpp b/src/expression/comparison_expression.cpp
@@ -63,8 +63,8 @@ AbstractExpression *ComparisonExpression::Copy() const {
 const std::string ComparisonExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Comparison,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Comparison]\n"
      << StringUtil::Indent(num_indent + 1)
      << "comparison type = " << ExpressionTypeToString(exp_type_) << "\n";
 
diff --git a/src/expression/conjunction_expression.cpp b/src/expression/conjunction_expression.cpp
@@ -18,8 +18,8 @@ namespace expression {
 const std::string ConjunctionExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Conjunction,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Conjunction]\n"
      << StringUtil::Indent(num_indent + 1)
      << "conjunction type = " << ExpressionTypeToString(exp_type_) << "\n";
 
diff --git a/src/expression/constant_value_expression.cpp b/src/expression/constant_value_expression.cpp
@@ -18,9 +18,8 @@ namespace expression {
 const std::string ConstantValueExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1)
-     << "expression type = Constant Value,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Constant Value]\n"
      << StringUtil::Indent(num_indent + 1) << "value: " << value_.GetInfo()
      << std::endl;
 
diff --git a/src/expression/function_expression.cpp b/src/expression/function_expression.cpp
@@ -84,8 +84,8 @@ void FunctionExpression::SetUDFFunctionExpressionParameters(
 const std::string FunctionExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Function,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Function]\n"
      << StringUtil::Indent(num_indent + 1) << "function name: " << func_name_
      << "\n"
      << StringUtil::Indent(num_indent + 1) << "function args: " << std::endl;
diff --git a/src/expression/operator_expression.cpp b/src/expression/operator_expression.cpp
@@ -18,8 +18,8 @@ namespace expression {
 const std::string OperatorExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Operator,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Operator]\n"
      << StringUtil::Indent(num_indent + 1)
      << "operator name: " << ExpressionTypeToString(exp_type_) << std::endl;
 
diff --git a/src/expression/parameter_value_expression.cpp b/src/expression/parameter_value_expression.cpp
@@ -72,9 +72,8 @@ void ParameterValueExpression::VisitParameters(
 const std::string ParameterValueExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1)
-     << "expression type = Parameter Value,\n"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Parameter Value]\n"
      << StringUtil::Indent(num_indent + 1)
      << "value index: " << std::to_string(value_idx_)
      << StringUtil::Indent(num_indent + 1)
diff --git a/src/expression/star_expression.cpp b/src/expression/star_expression.cpp
@@ -20,8 +20,8 @@ namespace expression {
 const std::string StarExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1) << "expression type = Star,"
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Star]"
      << std::endl;
 
   return os.str();
diff --git a/src/expression/tuple_value_expression.cpp b/src/expression/tuple_value_expression.cpp
@@ -62,9 +62,8 @@ bool TupleValueExpression::IsNullable() const { return ai_->type.nullable; }
 const std::string TupleValueExpression::GetInfo(int num_indent) const {
   std::ostringstream os;
 
-  os << StringUtil::Indent(num_indent) << "Expression ::\n"
-     << StringUtil::Indent(num_indent + 1)
-     << "expression type = Tuple Value,\n";
+  os << StringUtil::Indent(num_indent) << "-[Expression :: "
+     << "Tuple Value]\n";
   if (table_name_.size() > 0) {
     os << StringUtil::Indent(num_indent + 1) << "table name: " << table_name_
        << std::endl;
diff --git a/src/include/optimizer/group.h b/src/include/optimizer/group.h
@@ -32,7 +32,7 @@ class ColumnStats;
 //===--------------------------------------------------------------------===//
 // Group
 //===--------------------------------------------------------------------===//
-class Group {
+class Group : public Printable {
  public:
   Group(GroupID id, std::unordered_set<std::string> table_alias);
 
@@ -90,7 +90,10 @@ class Group {
 
   int GetNumRows() { return num_rows_; }
 
-  inline GroupID GetID() { return id_; }
+  inline GroupID GetID() const { return id_; }
+
+  const std::string GetInfo(int num_indent) const;
+  const std::string GetInfo() const override;
 
   // This is called in rewrite phase to erase the only logical expression in the
   // group
diff --git a/src/include/optimizer/memo.h b/src/include/optimizer/memo.h
@@ -58,6 +58,9 @@ class Memo {
 
   Group* GetGroupByID(GroupID id);
 
+  const std::string GetInfo(int num_indent) const;
+  const std::string GetInfo() const;
+
   inline void SetRuleSetSize(size_t rule_set_size) {
     rule_set_size_ = rule_set_size;
   }
diff --git a/src/include/optimizer/optimizer.h b/src/include/optimizer/optimizer.h
@@ -127,6 +127,13 @@ class Optimizer : public AbstractOptimizer {
    */
   QueryInfo GetQueryInfo(parser::SQLStatement *tree);
 
+  /* GetOperatorInfo - get the best operator tree in the memo
+   * 
+   * take ChooseBestPlan as a reference                   
+   */
+  const std::string GetOperatorInfo(
+      GroupID id, std::shared_ptr<PropertySet> required_props, int num_indent);
+
   /* ChooseBestPlan - retrieve the lowest cost tree of physical operators for
    *     the given properties
    *
diff --git a/src/include/planner/analyze_plan.h b/src/include/planner/analyze_plan.h
@@ -60,7 +60,7 @@ class AnalyzePlan : public AbstractPlan {
 
   inline std::vector<char *> GetColumnNames() const { return column_names_; }
 
-  const std::string GetInfo() const { return "Analyze table"; }
+  const std::string GetInfo() const { return "Analyze table Plan"; }
 
   inline std::unique_ptr<AbstractPlan> Copy() const {
     return std::unique_ptr<AbstractPlan>(new AnalyzePlan(target_table_));
diff --git a/src/include/planner/append_plan.h b/src/include/planner/append_plan.h
@@ -27,7 +27,7 @@ class AppendPlan : public AbstractPlan {
 
   inline PlanNodeType GetPlanNodeType() const { return PlanNodeType::APPEND; }
 
-  const std::string GetInfo() const { return "Append"; }
+  const std::string GetInfo() const { return "AppendPlan"; }
 
   std::unique_ptr<AbstractPlan> Copy() const {
     return std::unique_ptr<AbstractPlan>(new AppendPlan());
@@ -38,4 +38,4 @@ class AppendPlan : public AbstractPlan {
 };
 
 }  // namespace planner
-}  // namespace peloton
+}  // namespace peloton
diff --git a/src/include/planner/csv_scan_plan.h b/src/include/planner/csv_scan_plan.h
@@ -61,6 +61,8 @@ class CSVScanPlan : public AbstractScan {
 
   const std::string &GetFileName() const { return file_name_; }
 
+  const std::string GetInfo() const override { return "CSVScanPlan"; }
+
   void GetAttributes(std::vector<const AttributeInfo *> &ais) const override;
 
   char GetDelimiterChar() const { return delimiter_; }
@@ -94,4 +96,4 @@ class CSVScanPlan : public AbstractScan {
 };
 
 }  // namespace planner
-}  // namespace peloton
+}  // namespace peloton
diff --git a/src/include/planner/export_external_file_plan.h b/src/include/planner/export_external_file_plan.h
@@ -45,6 +45,8 @@ class ExportExternalFilePlan : public AbstractPlan {
   char GetQuoteChar() const { return quote_; }
   char GetEscapeChar() const { return escape_; }
 
+  const std::string GetInfo() const override { return "ExportExternalFilePlan"; }
+
   //////////////////////////////////////////////////////////////////////////////
   ///
   /// Utilities + Internal
@@ -70,4 +72,4 @@ class ExportExternalFilePlan : public AbstractPlan {
 };
 
 }  // namespace planner
-}  // namespace peloton
+}  // namespace peloton
diff --git a/src/include/planner/hash_join_plan.h b/src/include/planner/hash_join_plan.h
@@ -55,7 +55,7 @@ class HashJoinPlan : public AbstractJoinPlan {
 
   void SetBloomFilterFlag(bool flag) { build_bloomfilter_ = flag; }
 
-  const std::string GetInfo() const override { return "HashJoin"; }
+  const std::string GetInfo() const override { return "HashJoinPlan"; }
 
   void GetLeftHashKeys(
       std::vector<const expression::AbstractExpression *> &keys) const;
diff --git a/src/include/planner/hash_plan.h b/src/include/planner/hash_plan.h
@@ -38,7 +38,7 @@ class HashPlan : public AbstractPlan {
 
   inline PlanNodeType GetPlanNodeType() const override { return PlanNodeType::HASH; }
 
-  const std::string GetInfo() const override { return "Hash"; }
+  const std::string GetInfo() const override { return "HashPlan"; }
 
   inline const std::vector<HashKeyPtrType> &GetHashKeys() const {
     return this->hash_keys_;
diff --git a/src/include/planner/hybrid_scan_plan.h b/src/include/planner/hybrid_scan_plan.h
@@ -38,11 +38,11 @@ class HybridScanPlan : public AbstractScan {
 
   ~HybridScanPlan() {}
 
-  std::unique_ptr<AbstractPlan> Copy() const {
+  std::unique_ptr<AbstractPlan> Copy() const override {
     return std::unique_ptr<AbstractPlan>(nullptr);
   }
 
-  PlanNodeType GetPlanNodeType() const { return PlanNodeType::SEQSCAN; }
+  PlanNodeType GetPlanNodeType() const override { return PlanNodeType::SEQSCAN; }
 
   oid_t GetIndexId() const { return index_id_; }
 
@@ -62,6 +62,8 @@ class HybridScanPlan : public AbstractScan {
 
   HybridScanType GetHybridType() const { return type_; }
 
+  const std::string GetInfo() const override { return "HybridScanPlan"; }
+
  private:
   HybridScanType type_ = HybridScanType::INVALID;
 
diff --git a/src/include/planner/index_scan_plan.h b/src/include/planner/index_scan_plan.h
@@ -145,7 +145,7 @@ class IndexScanPlan : public AbstractScan {
 
   inline bool GetDescend() const { return descend_; }
 
-  const std::string GetInfo() const { return "IndexScan"; }
+  const std::string GetInfo() const { return "IndexScanPlan"; }
 
   void SetLimit(bool limit) { limit_ = limit; }
 
diff --git a/src/include/planner/limit_plan.h b/src/include/planner/limit_plan.h
@@ -38,7 +38,7 @@ class LimitPlan : public AbstractPlan {
 
   inline PlanNodeType GetPlanNodeType() const { return PlanNodeType::LIMIT; }
 
-  const std::string GetInfo() const { return "Limit"; }
+  const std::string GetInfo() const { return "LimitPlan"; }
 
   std::unique_ptr<AbstractPlan> Copy() const {
     return std::unique_ptr<AbstractPlan>(new LimitPlan(limit_, offset_));
@@ -53,4 +53,4 @@ class LimitPlan : public AbstractPlan {
 };
 
 }  // namespace planner
-}  // namespace peloton
+}  // namespace peloton
diff --git a/src/include/planner/materialization_plan.h b/src/include/planner/materialization_plan.h
@@ -49,7 +49,7 @@ class MaterializationPlan : public AbstractPlan {
     return PlanNodeType::MATERIALIZE;
   }
 
-  const std::string GetInfo() const { return "Materialize"; }
+  const std::string GetInfo() const { return "MaterializePlan"; }
 
   std::unique_ptr<AbstractPlan> Copy() const {
     std::shared_ptr<const catalog::Schema> schema_copy(
@@ -78,4 +78,4 @@ class MaterializationPlan : public AbstractPlan {
 };
 
 }  // namespace planner
-}  // namespace peloton
+}  // namespace peloton
diff --git a/src/include/planner/merge_join_plan.h b/src/include/planner/merge_join_plan.h
@@ -72,7 +72,7 @@ class MergeJoinPlan : public AbstractJoinPlan {
     return &join_clauses_;
   }
 
-  const std::string GetInfo() const override { return "MergeJoin"; }
+  const std::string GetInfo() const override { return "MergeJoinPlan"; }
 
   std::unique_ptr<AbstractPlan> Copy() const override {
     std::vector<JoinClause> new_join_clauses;
diff --git a/src/include/planner/mock_plan.h b/src/include/planner/mock_plan.h
@@ -37,7 +37,7 @@ class MockPlan : public planner::AbstractPlan {
   // Utilities
   //===--------------------------------------------------------------------===//
 
-  inline const std::string GetInfo() const { return "Mock"; }
+  inline const std::string GetInfo() const { return "MockPlan"; }
 
   std::unique_ptr<planner::AbstractPlan> Copy() const {
     return std::unique_ptr<AbstractPlan>(new MockPlan());
diff --git a/src/include/planner/nested_loop_join_plan.h b/src/include/planner/nested_loop_join_plan.h
@@ -44,7 +44,7 @@ class NestedLoopJoinPlan : public AbstractJoinPlan {
     return PlanNodeType::NESTLOOP;
   }
 
-  const std::string GetInfo() const override { return "NestedLoopJoin"; }
+  const std::string GetInfo() const override { return "NestedLoopJoinPlan"; }
 
   std::unique_ptr<AbstractPlan> Copy() const override;
 
diff --git a/src/include/planner/order_by_plan.h b/src/include/planner/order_by_plan.h
@@ -65,7 +65,7 @@ class OrderByPlan : public AbstractPlan {
   }
 
   const std::string GetInfo() const override {
-    return std::string("OrderBy") +
+    return std::string("OrderByPlan") +
            (limit_
                 ? "(Limit : " + std::to_string(limit_number_) + ", Offset : " +
                       std::to_string(limit_offset_) + ")"
diff --git a/src/include/planner/populate_index_plan.h b/src/include/planner/populate_index_plan.h
@@ -43,7 +43,7 @@ class PopulateIndexPlan : public AbstractPlan {
 
   inline const std::vector<oid_t> &GetColumnIds() const { return column_ids_; }
 
-  const std::string GetInfo() const { return "PopulateIndex"; }
+  const std::string GetInfo() const { return "PopulateIndexPlan"; }
 
   storage::DataTable *GetTable() const { return target_table_; }
 
diff --git a/src/include/planner/projection_plan.h b/src/include/planner/projection_plan.h
@@ -53,7 +53,7 @@ class ProjectionPlan : public AbstractPlan {
     return PlanNodeType::PROJECTION;
   }
 
-  const std::string GetInfo() const override { return "Projection"; }
+  const std::string GetInfo() const override { return "ProjectionPlan"; }
 
   const std::vector<oid_t> &GetColumnIds() const { return column_ids_; }
 
diff --git a/src/include/planner/result_plan.h b/src/include/planner/result_plan.h
@@ -40,7 +40,7 @@ class ResultPlan : public AbstractPlan {
 
   inline PlanNodeType GetPlanNodeType() const { return PlanNodeType::RESULT; }
 
-  inline std::string GetInfo() const { return "Result"; }
+  inline std::string GetInfo() const { return "ResultPlan"; }
 
   std::unique_ptr<AbstractPlan> Copy() const {
     return std::unique_ptr<AbstractPlan>(
@@ -60,4 +60,4 @@ class ResultPlan : public AbstractPlan {
 };
 
 }  // namespace planner
-}  // namespace peloton
+}  // namespace peloton
diff --git a/src/include/planner/seq_scan_plan.h b/src/include/planner/seq_scan_plan.h
@@ -43,7 +43,7 @@ class SeqScanPlan : public AbstractScan {
   }
 
   const std::string GetInfo() const override {
-    return "SeqScan(" + GetPredicateInfo() + ")";
+    return "SeqScanPlan(" + GetPredicateInfo() + ")";
   }
 
   void SetParameterValues(std::vector<type::Value> *values) override;
diff --git a/src/include/planner/set_op_plan.h b/src/include/planner/set_op_plan.h
diff --git a/src/optimizer/group.cpp b/src/optimizer/group.cpp
diff --git a/src/optimizer/memo.cpp b/src/optimizer/memo.cpp
diff --git a/src/optimizer/optimizer.cpp b/src/optimizer/optimizer.cpp
