ExplainInfo Class Reference

#include <ParserWrapper.h>

Collaboration diagram for ExplainInfo:

Public Types
enum	ExplainType {   ExplainType::None, ExplainType::IR, ExplainType::OptimizedIR, ExplainType::Calcite,   ExplainType::CalciteDetail, ExplainType::ExecutionPlan, ExplainType::Other }

Public Member Functions
	ExplainInfo ()
	ExplainInfo (ExplainType type)
	ExplainInfo (std::string query_string)
bool	isExplain () const
bool	isJustExplain () const
bool	isSelectExplain () const
bool	isIRExplain () const
bool	isOptimizedExplain () const
bool	isCalciteExplain () const
bool	isCalciteExplainDetail () const
bool	isPlanExplain () const
bool	isOtherExplain () const
std::string	ActualQuery ()
bool	isVerbose () const

Private Attributes
ExplainType	explain_type_ = ExplainType::None
std::string	actual_query_ = ""
bool	verbose_ {false}

Detailed Description

Definition at line 34 of file ParserWrapper.h.

Member Enumeration Documentation

enum ExplainInfo::ExplainType

strong

Enumerator
None
IR
OptimizedIR
Calcite
CalciteDetail
ExecutionPlan
Other

Definition at line 36 of file ParserWrapper.h.

                         {
    None,
    IR,
    OptimizedIR,
    Calcite,
    CalciteDetail,
    ExecutionPlan,
    Other
  };

Constructor & Destructor Documentation

ExplainInfo::ExplainInfo ( )

inline

Definition at line 46 of file ParserWrapper.h.

: explain_type_(ExplainType::None), actual_query_("") {}

ExplainInfo::ExplainInfo ( ExplainType  type )

inline

Definition at line 47 of file ParserWrapper.h.

: explain_type_(type), actual_query_("") {}

ExplainInfo::ExplainInfo

(

std::string

query_string

)

Definition at line 41 of file ParserWrapper.cpp.

References anonymous_namespace{ParserWrapper.cpp}::calcite_explain_detailed_str, anonymous_namespace{ParserWrapper.cpp}::calcite_explain_str, anonymous_namespace{ParserWrapper.cpp}::explain_str, logger::IR, anonymous_namespace{ExtensionFunctionsGeo.hpp}::None, anonymous_namespace{ParserWrapper.cpp}::optimized_explain_str, anonymous_namespace{ParserWrapper.cpp}::plan_explain_detailed_str, and anonymous_namespace{ParserWrapper.cpp}::plan_explain_str.

                                               {
  // sets explain_type_ and caches a trimmed actual_query_
  explain_type_ = ExplainType::None;
  actual_query_ = "";

  if (boost::istarts_with(query_string, explain_str)) {
    if (boost::istarts_with(query_string, calcite_explain_str)) {
      if (boost::istarts_with(query_string, calcite_explain_detailed_str)) {
        explain_type_ = ExplainType::CalciteDetail;
        actual_query_ =
            boost::trim_copy(query_string.substr(calcite_explain_detailed_str.size()));
      } else {
        actual_query_ = boost::trim_copy(query_string.substr(calcite_explain_str.size()));
        explain_type_ = ExplainType::Calcite;
      }
    } else if (boost::istarts_with(query_string, optimized_explain_str)) {
      actual_query_ = boost::trim_copy(query_string.substr(optimized_explain_str.size()));
      explain_type_ = ExplainType::OptimizedIR;
    } else if (boost::istarts_with(query_string, plan_explain_str)) {
      if (boost::istarts_with(query_string, plan_explain_detailed_str)) {
        actual_query_ =
            boost::trim_copy(query_string.substr(plan_explain_detailed_str.size()));
        verbose_ = true;
      } else {
        actual_query_ = boost::trim_copy(query_string.substr(plan_explain_str.size()));
      }
      explain_type_ = ExplainType::ExecutionPlan;
    } else {
      actual_query_ = boost::trim_copy(query_string.substr(explain_str.size()));
      explain_type_ = ExplainType::IR;
    }
    // override condition: ddl, update_dml
    ParserWrapper inner{actual_query_};
    if (inner.is_ddl || inner.is_update_dml) {
      explain_type_ = ExplainType::Other;
    }
  }
}

Member Function Documentation

std::string ExplainInfo::ActualQuery ( )

inline

Definition at line 81 of file ParserWrapper.h.

References actual_query_.

Referenced by DBHandler::processCalciteRequest(), and DBHandler::sql_execute_impl().

{ return actual_query_; }

Here is the caller graph for this function:

bool ExplainInfo::isCalciteExplain ( ) const

inline

Definition at line 71 of file ParserWrapper.h.

References Calcite, CalciteDetail, and explain_type_.

Referenced by DBHandler::execute_rel_alg(), DBHandler::processCalciteRequest(), and DBHandler::sql_execute_impl().

                                {
    return explain_type_ == ExplainType::Calcite ||
           explain_type_ == ExplainType::CalciteDetail;
  }

Here is the caller graph for this function:

bool ExplainInfo::isCalciteExplainDetail ( ) const

inline

Definition at line 75 of file ParserWrapper.h.

References CalciteDetail, and explain_type_.

Referenced by DBHandler::processCalciteRequest().

                                      {
    return explain_type_ == ExplainType::CalciteDetail;
  }

Here is the caller graph for this function:

bool ExplainInfo::isExplain ( ) const

inline

Definition at line 50 of file ParserWrapper.h.

References explain_type_, and None.

{ return explain_type_ != ExplainType::None; }

bool ExplainInfo::isIRExplain ( ) const

inline

Definition at line 66 of file ParserWrapper.h.

References explain_type_, IR, and OptimizedIR.

                           {
    return explain_type_ == ExplainType::IR || explain_type_ == ExplainType::OptimizedIR;
  }

bool ExplainInfo::isJustExplain ( ) const

inline

Definition at line 52 of file ParserWrapper.h.

References ExecutionPlan, explain_type_, IR, and OptimizedIR.

Referenced by DBHandler::execute_rel_alg().

                             {
    return explain_type_ == ExplainType::IR ||
           explain_type_ == ExplainType::OptimizedIR ||
           explain_type_ == ExplainType::ExecutionPlan;
  }

Here is the caller graph for this function:

bool ExplainInfo::isOptimizedExplain ( ) const

inline

Definition at line 70 of file ParserWrapper.h.

References explain_type_, and OptimizedIR.

Referenced by DBHandler::execute_rel_alg().

{ return explain_type_ == ExplainType::OptimizedIR; }

Here is the caller graph for this function:

bool ExplainInfo::isOtherExplain ( ) const

inline

Definition at line 79 of file ParserWrapper.h.

References explain_type_, and Other.

Referenced by ParserWrapper::ParserWrapper().

{ return explain_type_ == ExplainType::Other; }

Here is the caller graph for this function:

bool ExplainInfo::isPlanExplain ( ) const

inline

Definition at line 78 of file ParserWrapper.h.

References ExecutionPlan, and explain_type_.

Referenced by DBHandler::execute_rel_alg().

{ return explain_type_ == ExplainType::ExecutionPlan; }

Here is the caller graph for this function:

bool ExplainInfo::isSelectExplain ( ) const

inline

Definition at line 58 of file ParserWrapper.h.

References Calcite, CalciteDetail, ExecutionPlan, explain_type_, IR, and OptimizedIR.

Referenced by DBHandler::processCalciteRequest().

                               {
    return explain_type_ == ExplainType::IR ||
           explain_type_ == ExplainType::OptimizedIR ||
           explain_type_ == ExplainType::Calcite ||
           explain_type_ == ExplainType::CalciteDetail ||
           explain_type_ == ExplainType::ExecutionPlan;
  }

Here is the caller graph for this function:

bool ExplainInfo::isVerbose ( ) const

inline

Definition at line 83 of file ParserWrapper.h.

References verbose_.

Referenced by DBHandler::execute_rel_alg().

{ return verbose_; }

Here is the caller graph for this function:

Member Data Documentation

std::string ExplainInfo::actual_query_ = ""

private

Definition at line 87 of file ParserWrapper.h.

Referenced by ActualQuery().

ExplainType ExplainInfo::explain_type_ = ExplainType::None

private

Definition at line 86 of file ParserWrapper.h.

Referenced by isCalciteExplain(), isCalciteExplainDetail(), isExplain(), isIRExplain(), isJustExplain(), isOptimizedExplain(), isOtherExplain(), isPlanExplain(), and isSelectExplain().

bool ExplainInfo::verbose_ {false}

private

Definition at line 88 of file ParserWrapper.h.

Referenced by isVerbose().

---

The documentation for this class was generated from the following files:

• /home/jenkins-slave/workspace/core-os-doxygen/Parser/ParserWrapper.h
• /home/jenkins-slave/workspace/core-os-doxygen/Parser/ParserWrapper.cpp