RelAlgDagBuilder Class Reference

#include <RelAlgDagBuilder.h>

Inheritance diagram for RelAlgDagBuilder:

Collaboration diagram for RelAlgDagBuilder:

Public Member Functions
	RelAlgDagBuilder ()=delete
	RelAlgDagBuilder (const std::string &query_ra, const Catalog_Namespace::Catalog &cat, const RenderInfo *render_info)
	RelAlgDagBuilder (RelAlgDagBuilder &root_dag_builder, const rapidjson::Value &query_ast, const Catalog_Namespace::Catalog &cat, const RenderInfo *render_opts)
void	eachNode (std::function< void(RelAlgNode const *)> const &) const
const RelAlgNode &	getRootNode () const
std::shared_ptr< const RelAlgNode >	getRootNodeShPtr () const
void	registerSubquery (std::shared_ptr< RexSubQuery > subquery)
const std::vector < std::shared_ptr< RexSubQuery > > &	getSubqueries () const
void	registerQueryHints (QueryHint &query_hint)
const QueryHint	getQueryHints () const
void	resetQueryExecutionState ()

Private Member Functions
void	build (const rapidjson::Value &query_ast, RelAlgDagBuilder &root_dag_builder)

Private Attributes
const Catalog_Namespace::Catalog &	cat_
std::vector< std::shared_ptr < RelAlgNode > >	nodes_
std::vector< std::shared_ptr < RexSubQuery > >	subqueries_
const RenderInfo *	render_info_
QueryHint	query_hint_

Detailed Description

Builder class to create an in-memory, easy-to-navigate relational algebra DAG interpreted from a JSON representation from Calcite. Also, applies high level optimizations which can be expressed through relational algebra extended with RelCompound. The RelCompound node is an equivalent representation for sequences of RelFilter, RelProject and RelAggregate nodes. This coalescing minimizes the amount of intermediate buffers required to evaluate a query. Lower level optimizations are taken care by lower levels, mainly RelAlgTranslator and the IR code generation.

Definition at line 1775 of file RelAlgDagBuilder.h.

Constructor & Destructor Documentation

RelAlgDagBuilder::RelAlgDagBuilder ( )

delete

RelAlgDagBuilder::RelAlgDagBuilder	(	const std::string &	query_ra,
		const Catalog_Namespace::Catalog &	cat,
		const RenderInfo *	render_info
	)

Constructs a RelAlg DAG from a JSON representation.

Parameters

query_ra	A JSON string representation of an RA tree from Calcite.
cat	DB catalog for the current user.
render_opts	Additional build options for render queries.

Definition at line 2575 of file RelAlgDagBuilder.cpp.

References build(), CHECK, logger::ERROR, LOG, RelAlgNode::resetRelAlgFirstId(), and VLOG.

    : cat_(cat), render_info_(render_info) {
  rapidjson::Document query_ast;
  query_ast.Parse(query_ra.c_str());
  VLOG(2) << "Parsing query RA JSON: " << query_ra;
  if (query_ast.HasParseError()) {
    query_ast.GetParseError();
    LOG(ERROR) << "Failed to parse RA tree from Calcite (offset "
               << query_ast.GetErrorOffset() << "):\n"
               << rapidjson::GetParseError_En(query_ast.GetParseError());
    VLOG(1) << "Failed to parse query RA: " << query_ra;
    throw std::runtime_error(
        "Failed to parse relational algebra tree. Possible query syntax error.");
  }
  CHECK(query_ast.IsObject());
  RelAlgNode::resetRelAlgFirstId();
  build(query_ast, *this);
}

Here is the call graph for this function:

RelAlgDagBuilder::RelAlgDagBuilder	(	RelAlgDagBuilder &	root_dag_builder,
		const rapidjson::Value &	query_ast,
		const Catalog_Namespace::Catalog &	cat,
		const RenderInfo *	render_opts
	)

Constructs a sub-DAG for any subqueries. Should only be called during DAG building.

Parameters

root_dag_builder	The root DAG builder. The root stores pointers to all subqueries.
query_ast	The current JSON node to build a DAG for.
cat	DB catalog for the current user.
render_opts	Additional build options for render queries.

Definition at line 2596 of file RelAlgDagBuilder.cpp.

References build().

    : cat_(cat), render_info_(render_info) {
  build(query_ast, root_dag_builder);
}

Here is the call graph for this function:

Member Function Documentation

void RelAlgDagBuilder::build ( const rapidjson::Value &  query_ast, RelAlgDagBuilder &  root_dag_builder  )

private

Definition at line 2604 of file RelAlgDagBuilder.cpp.

References anonymous_namespace{RelAlgDagBuilder.cpp}::add_window_function_pre_project(), alterRAForRender(), anonymous_namespace{RelAlgDagBuilder.cpp}::bind_inputs(), cat_, CHECK, anonymous_namespace{RelAlgDagBuilder.cpp}::coalesce_nodes(), anonymous_namespace{RelLeftDeepInnerJoin.cpp}::create_left_deep_join(), eliminate_dead_columns(), eliminate_dead_subqueries(), eliminate_identical_copy(), field(), fold_filters(), g_cluster, get_left_deep_join_root(), anonymous_namespace{RelAlgDagBuilder.cpp}::handleQueryHint(), hoist_filter_cond_to_cross_join(), anonymous_namespace{RelAlgDagBuilder.cpp}::mark_nops(), nodes_, render_info_, details::RelAlgDispatcher::run(), anonymous_namespace{RelAlgDagBuilder.cpp}::separate_window_function_expressions(), simplify_sort(), sink_projected_boolean_expr_to_join(), and subqueries_.

Referenced by RelAlgDagBuilder().

                                                                 {
  const auto& rels = field(query_ast, "rels");
  CHECK(rels.IsArray());
  try {
    nodes_ = details::RelAlgDispatcher(cat_).run(rels, lead_dag_builder);
  } catch (const QueryNotSupported&) {
    throw;
  }
  CHECK(!nodes_.empty());
  bind_inputs(nodes_);

  if (render_info_) {
    // Alter the RA for render. Do this before any flattening/optimizations are done to
    // the tree.
    alterRAForRender(nodes_, *render_info_);
  }

  handleQueryHint(nodes_, this);
  mark_nops(nodes_);
  simplify_sort(nodes_);
  sink_projected_boolean_expr_to_join(nodes_);
  eliminate_identical_copy(nodes_);
  fold_filters(nodes_);
  std::vector<const RelAlgNode*> filtered_left_deep_joins;
  std::vector<const RelAlgNode*> left_deep_joins;
  for (const auto& node : nodes_) {
    const auto left_deep_join_root = get_left_deep_join_root(node);
    // The filter which starts a left-deep join pattern must not be coalesced
    // since it contains (part of) the join condition.
    if (left_deep_join_root) {
      left_deep_joins.push_back(left_deep_join_root.get());
      if (std::dynamic_pointer_cast<const RelFilter>(left_deep_join_root)) {
        filtered_left_deep_joins.push_back(left_deep_join_root.get());
      }
    }
  }
  if (filtered_left_deep_joins.empty()) {
    hoist_filter_cond_to_cross_join(nodes_);
  }
  eliminate_dead_columns(nodes_);
  eliminate_dead_subqueries(subqueries_, nodes_.back().get());
  separate_window_function_expressions(nodes_);
  if (g_cluster) {
    add_window_function_pre_project(nodes_);
  }
  coalesce_nodes(nodes_, left_deep_joins);
  CHECK(nodes_.back().use_count() == 1);
  create_left_deep_join(nodes_);
}

Here is the call graph for this function:

Here is the caller graph for this function:

void RelAlgDagBuilder::eachNode

(

std::function< void(RelAlgNode const *)> const &

callback

)

const

Definition at line 2655 of file RelAlgDagBuilder.cpp.

References nodes_.

                                                                {
  for (auto const& node : nodes_) {
    if (node) {
      callback(node.get());
    }
  }
}

const QueryHint RelAlgDagBuilder::getQueryHints ( ) const

inline

Definition at line 1837 of file RelAlgDagBuilder.h.

References query_hint_.

{ return query_hint_; }

const RelAlgNode& RelAlgDagBuilder::getRootNode ( ) const

inline

Returns the root node of the DAG.

Definition at line 1808 of file RelAlgDagBuilder.h.

References CHECK, and nodes_.

                                        {
    CHECK(nodes_.size());
    const auto& last_ptr = nodes_.back();
    CHECK(last_ptr);
    return *last_ptr;
  }

std::shared_ptr<const RelAlgNode> RelAlgDagBuilder::getRootNodeShPtr ( ) const

inline

Definition at line 1815 of file RelAlgDagBuilder.h.

References CHECK, and nodes_.

Referenced by anonymous_namespace{RelAlgDagBuilder.cpp}::parse_subquery().

                                                           {
    CHECK(nodes_.size());
    return nodes_.back();
  }

Here is the caller graph for this function:

const std::vector<std::shared_ptr<RexSubQuery> >& RelAlgDagBuilder::getSubqueries ( ) const

inline

Gets all registered subqueries. Only the root DAG can contain subqueries.

Definition at line 1831 of file RelAlgDagBuilder.h.

References subqueries_.

                                                                     {
    return subqueries_;
  }

void RelAlgDagBuilder::registerQueryHints ( QueryHint &  query_hint )

inline

Definition at line 1835 of file RelAlgDagBuilder.h.

References query_hint_.

{ query_hint_ = query_hint; }

void RelAlgDagBuilder::registerSubquery ( std::shared_ptr< RexSubQuery >  subquery )

inline

Registers a subquery with a root DAG builder. Should only be called during DAG building and registration should only occur on the root.

Definition at line 1824 of file RelAlgDagBuilder.h.

References subqueries_.

Referenced by anonymous_namespace{RelAlgDagBuilder.cpp}::parse_subquery().

                                                             {
    subqueries_.push_back(subquery);
  }

Here is the caller graph for this function:

void RelAlgDagBuilder::resetQueryExecutionState

(

)

Gets all registered subqueries. Only the root DAG can contain subqueries.

Definition at line 2664 of file RelAlgDagBuilder.cpp.

References nodes_.

                                                {
  for (auto& node : nodes_) {
    if (node) {
      node->resetQueryExecutionState();
    }
  }
}

Member Data Documentation

const Catalog_Namespace::Catalog& RelAlgDagBuilder::cat_

private

Definition at line 1847 of file RelAlgDagBuilder.h.

Referenced by build().

std::vector<std::shared_ptr<RelAlgNode> > RelAlgDagBuilder::nodes_

private

Definition at line 1848 of file RelAlgDagBuilder.h.

Referenced by build(), eachNode(), getRootNode(), getRootNodeShPtr(), and resetQueryExecutionState().

QueryHint RelAlgDagBuilder::query_hint_

private

Definition at line 1851 of file RelAlgDagBuilder.h.

Referenced by getQueryHints(), and registerQueryHints().

const RenderInfo* RelAlgDagBuilder::render_info_

private

Definition at line 1850 of file RelAlgDagBuilder.h.

Referenced by build().

std::vector<std::shared_ptr<RexSubQuery> > RelAlgDagBuilder::subqueries_

private

Definition at line 1849 of file RelAlgDagBuilder.h.

Referenced by build(), getSubqueries(), and registerSubquery().

---

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

• /home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/RelAlgDagBuilder.h
• /home/jenkins-slave/workspace/core-os-doxygen/QueryEngine/RelAlgDagBuilder.cpp