OmniSciDB  cde582ebc3
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
RelAlgExecutionUnit.h File Reference

Execution unit for relational algebra. It's a low-level description of any relational algebra operation in a format understood by our VM. More...

#include "Descriptors/InputDescriptors.h"
#include "QueryHint.h"
#include "RelAlgDag.h"
#include "Shared/sqldefs.h"
#include "Shared/toString.h"
#include "TableFunctions/TableFunctionOutputBufferSizeType.h"
#include "TableFunctions/TableFunctionsFactory.h"
#include "ThriftHandler/QueryState.h"
#include <boost/graph/adjacency_list.hpp>
#include <list>
#include <memory>
#include <optional>
#include <vector>
+ Include dependency graph for RelAlgExecutionUnit.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

struct  HashTableBuildDag
 
struct  SortInfo
 
struct  JoinCondition
 
struct  RelAlgExecutionUnit
 
struct  TableFunctionExecutionUnit
 

Namespaces

 Analyzer
 

Typedefs

using AdjacentList = boost::adjacency_list< boost::setS, boost::vecS, boost::directedS >
 
using RelNodeId = size_t
 
using RelNodeExplainedHash = size_t
 
using QueryPlanDAG = std::string
 
using QueryPlanHash = size_t
 
using HashTableBuildDagMap = std::unordered_map< size_t, HashTableBuildDag >
 
using TableIdToNodeMap = std::unordered_map< int, const RelAlgNode * >
 
using JoinQualsPerNestingLevel = std::vector< JoinCondition >
 
using ResultSetPtr = std::shared_ptr< ResultSet >
 

Enumerations

enum  JoinColumnSide { kInner, kOuter, kQual, kDirect }
 
enum  SortAlgorithm { SortAlgorithm::Default, SortAlgorithm::SpeculativeTopN, SortAlgorithm::StreamingTopN }
 

Functions

std::ostream & operator<< (std::ostream &os, const RelAlgExecutionUnit &ra_exe_unit)
 
std::string ra_exec_unit_desc_for_caching (const RelAlgExecutionUnit &ra_exe_unit)
 

Variables

constexpr char const * EMPTY_QUERY_PLAN = ""
 
constexpr QueryPlanHash EMPTY_HASHED_PLAN_DAG_KEY = 0
 

Detailed Description

Execution unit for relational algebra. It's a low-level description of any relational algebra operation in a format understood by our VM.

Definition in file RelAlgExecutionUnit.h.

Typedef Documentation

using AdjacentList = boost::adjacency_list<boost::setS, boost::vecS, boost::directedS>

Definition at line 43 of file RelAlgExecutionUnit.h.

using HashTableBuildDagMap = std::unordered_map<size_t, HashTableBuildDag>

Definition at line 86 of file RelAlgExecutionUnit.h.

Definition at line 129 of file RelAlgExecutionUnit.h.

using QueryPlanDAG = std::string

Definition at line 56 of file RelAlgExecutionUnit.h.

using QueryPlanHash = size_t

Definition at line 58 of file RelAlgExecutionUnit.h.

using RelNodeExplainedHash = size_t

Definition at line 51 of file RelAlgExecutionUnit.h.

using RelNodeId = size_t

Definition at line 49 of file RelAlgExecutionUnit.h.

using ResultSetPtr = std::shared_ptr<ResultSet>

Definition at line 182 of file RelAlgExecutionUnit.h.

using TableIdToNodeMap = std::unordered_map<int, const RelAlgNode*>

Definition at line 94 of file RelAlgExecutionUnit.h.

Enumeration Type Documentation

Enumerator
kInner 
kOuter 
kQual 
kDirect 

Definition at line 96 of file RelAlgExecutionUnit.h.

96  {
97  kInner,
98  kOuter,
99  kQual, // INNER + OUTER
100  kDirect // set target directly (i.e., put Analyzer::Expr* instead of
101  // Analyzer::BinOper*)
102 };
enum SortAlgorithm
strong
Enumerator
Default 
SpeculativeTopN 
StreamingTopN 

Definition at line 106 of file RelAlgExecutionUnit.h.

Function Documentation

std::ostream& operator<< ( std::ostream &  os,
const RelAlgExecutionUnit ra_exe_unit 
)

Definition at line 1658 of file Execute.cpp.

References RelAlgExecutionUnit::estimator, anonymous_namespace{Execute.cpp}::expr_container_to_string(), RelAlgExecutionUnit::groupby_exprs, RelAlgExecutionUnit::input_col_descs, join(), RelAlgExecutionUnit::join_quals, RelAlgExecutionUnit::quals, RelAlgExecutionUnit::query_plan_dag_hash, RelAlgExecutionUnit::scan_limit, RelAlgExecutionUnit::simple_quals, anonymous_namespace{Execute.cpp}::sort_algorithm_to_string(), RelAlgExecutionUnit::sort_info, RelAlgExecutionUnit::target_exprs, to_string(), toString(), RelAlgExecutionUnit::union_all, and RelAlgExecutionUnit::use_bump_allocator.

1658  {
1659  os << "\n\tExtracted Query Plan Dag Hash: " << ra_exe_unit.query_plan_dag_hash;
1660  os << "\n\tTable/Col/Levels: ";
1661  for (const auto& input_col_desc : ra_exe_unit.input_col_descs) {
1662  const auto& scan_desc = input_col_desc->getScanDesc();
1663  os << "(" << scan_desc.getTableId() << ", " << input_col_desc->getColId() << ", "
1664  << scan_desc.getNestLevel() << ") ";
1665  }
1666  if (!ra_exe_unit.simple_quals.empty()) {
1667  os << "\n\tSimple Quals: "
1669  ", ");
1670  }
1671  if (!ra_exe_unit.quals.empty()) {
1672  os << "\n\tQuals: "
1673  << boost::algorithm::join(expr_container_to_string(ra_exe_unit.quals), ", ");
1674  }
1675  if (!ra_exe_unit.join_quals.empty()) {
1676  os << "\n\tJoin Quals: ";
1677  for (size_t i = 0; i < ra_exe_unit.join_quals.size(); i++) {
1678  const auto& join_condition = ra_exe_unit.join_quals[i];
1679  os << "\t\t" << std::to_string(i) << " " << ::toString(join_condition.type);
1680  os << boost::algorithm::join(expr_container_to_string(join_condition.quals), ", ");
1681  }
1682  }
1683  if (!ra_exe_unit.groupby_exprs.empty()) {
1684  os << "\n\tGroup By: "
1686  ", ");
1687  }
1688  os << "\n\tProjected targets: "
1690  os << "\n\tHas Estimator: " << ::toString(ra_exe_unit.estimator == nullptr);
1691  os << "\n\tSort Info: ";
1692  const auto& sort_info = ra_exe_unit.sort_info;
1693  os << "\n\t Order Entries: "
1694  << boost::algorithm::join(expr_container_to_string(sort_info.order_entries), ", ");
1695  os << "\n\t Algorithm: " << sort_algorithm_to_string(sort_info.algorithm);
1696  os << "\n\t Limit: " << std::to_string(sort_info.limit);
1697  os << "\n\t Offset: " << std::to_string(sort_info.offset);
1698  os << "\n\tScan Limit: " << std::to_string(ra_exe_unit.scan_limit);
1699  os << "\n\tBump Allocator: " << ::toString(ra_exe_unit.use_bump_allocator);
1700  if (ra_exe_unit.union_all) {
1701  os << "\n\tUnion: " << std::string(*ra_exe_unit.union_all ? "UNION ALL" : "UNION");
1702  }
1703  return os;
1704 }
std::vector< Analyzer::Expr * > target_exprs
QueryPlanHash query_plan_dag_hash
const std::optional< bool > union_all
std::string join(T const &container, std::string const &delim)
const std::list< std::shared_ptr< Analyzer::Expr > > groupby_exprs
std::string to_string(char const *&&v)
const JoinQualsPerNestingLevel join_quals
std::vector< std::string > expr_container_to_string(const T &expr_container)
Definition: Execute.cpp:1570
const std::shared_ptr< Analyzer::Estimator > estimator
std::string toString(const Executor::ExtModuleKinds &kind)
Definition: Execute.h:1448
std::string sort_algorithm_to_string(const SortAlgorithm algorithm)
Definition: Execute.cpp:1592
std::list< std::shared_ptr< Analyzer::Expr > > quals
std::list< std::shared_ptr< const InputColDescriptor > > input_col_descs
std::list< std::shared_ptr< Analyzer::Expr > > simple_quals

+ Here is the call graph for this function:

std::string ra_exec_unit_desc_for_caching ( const RelAlgExecutionUnit ra_exe_unit)

Definition at line 1607 of file Execute.cpp.

References RelAlgExecutionUnit::estimator, RelAlgExecutionUnit::groupby_exprs, RelAlgExecutionUnit::input_col_descs, RelAlgExecutionUnit::join_quals, RelAlgExecutionUnit::quals, RelAlgExecutionUnit::scan_limit, RelAlgExecutionUnit::simple_quals, RelAlgExecutionUnit::target_exprs, to_string(), and toString().

Referenced by RelAlgExecutor::executeWorkUnit().

1607  {
1608  // todo(yoonmin): replace a cache key as a DAG representation of a query plan
1609  // instead of ra_exec_unit description if possible
1610  std::ostringstream os;
1611  for (const auto& input_col_desc : ra_exe_unit.input_col_descs) {
1612  const auto& scan_desc = input_col_desc->getScanDesc();
1613  os << scan_desc.getTableId() << "," << input_col_desc->getColId() << ","
1614  << scan_desc.getNestLevel();
1615  }
1616  if (!ra_exe_unit.simple_quals.empty()) {
1617  for (const auto& qual : ra_exe_unit.simple_quals) {
1618  if (qual) {
1619  os << qual->toString() << ",";
1620  }
1621  }
1622  }
1623  if (!ra_exe_unit.quals.empty()) {
1624  for (const auto& qual : ra_exe_unit.quals) {
1625  if (qual) {
1626  os << qual->toString() << ",";
1627  }
1628  }
1629  }
1630  if (!ra_exe_unit.join_quals.empty()) {
1631  for (size_t i = 0; i < ra_exe_unit.join_quals.size(); i++) {
1632  const auto& join_condition = ra_exe_unit.join_quals[i];
1633  os << std::to_string(i) << ::toString(join_condition.type);
1634  for (const auto& qual : join_condition.quals) {
1635  if (qual) {
1636  os << qual->toString() << ",";
1637  }
1638  }
1639  }
1640  }
1641  if (!ra_exe_unit.groupby_exprs.empty()) {
1642  for (const auto& qual : ra_exe_unit.groupby_exprs) {
1643  if (qual) {
1644  os << qual->toString() << ",";
1645  }
1646  }
1647  }
1648  for (const auto& expr : ra_exe_unit.target_exprs) {
1649  if (expr) {
1650  os << expr->toString() << ",";
1651  }
1652  }
1653  os << ::toString(ra_exe_unit.estimator == nullptr);
1654  os << std::to_string(ra_exe_unit.scan_limit);
1655  return os.str();
1656 }
std::vector< Analyzer::Expr * > target_exprs
const std::list< std::shared_ptr< Analyzer::Expr > > groupby_exprs
std::string to_string(char const *&&v)
const JoinQualsPerNestingLevel join_quals
const std::shared_ptr< Analyzer::Estimator > estimator
std::string toString(const Executor::ExtModuleKinds &kind)
Definition: Execute.h:1448
std::list< std::shared_ptr< Analyzer::Expr > > quals
std::list< std::shared_ptr< const InputColDescriptor > > input_col_descs
std::list< std::shared_ptr< Analyzer::Expr > > simple_quals

+ Here is the call graph for this function:

+ Here is the caller graph for this function:

Variable Documentation

constexpr char const* EMPTY_QUERY_PLAN = ""