#include <Analyzer.h>

Inheritance diagram for Analyzer::WindowFunction:

Collaboration diagram for Analyzer::WindowFunction:

Public Types
enum	FrameBoundType { FrameBoundType::NONE, FrameBoundType::ROW, FrameBoundType::RANGE }

Public Member Functions
	WindowFunction (const SQLTypeInfo &ti, const SqlWindowFunctionKind kind, const std::vector< std::shared_ptr< Analyzer::Expr >> &args, const std::vector< std::shared_ptr< Analyzer::Expr >> &partition_keys, const std::vector< std::shared_ptr< Analyzer::Expr >> &order_keys, const FrameBoundType frame_bound_type, const std::shared_ptr< Expr > frame_start_bound, const std::shared_ptr< Expr > frame_end_bound, const std::vector< OrderEntry > &collation)

std::shared_ptr< Analyzer::Expr >	deep_copy () const override

bool	operator== (const Expr &rhs) const override

std::string	toString () const override

SqlWindowFunctionKind	getKind () const

const std::vector < std::shared_ptr < Analyzer::Expr > > &	getArgs () const

const std::vector < std::shared_ptr < Analyzer::Expr > > &	getPartitionKeys () const

const std::vector < std::shared_ptr < Analyzer::Expr > > &	getOrderKeys () const

const Analyzer::WindowFrame *	getFrameStartBound () const

const Analyzer::WindowFrame *	getFrameEndBound () const

const std::vector< OrderEntry > &	getCollation () const

Analyzer::WindowFunction::FrameBoundType	getFrameBoundType () const

bool	hasRowModeFraming () const

bool	hasRangeModeFraming () const

bool	hasFraming () const

bool	hasAggregateTreeRequiredWindowFunc () const

bool	isFrameNavigateWindowFunction () const

Public Member Functions inherited from Analyzer::Expr
	Expr (SQLTypes t, bool notnull)

	Expr (SQLTypes t, int d, bool notnull)

	Expr (SQLTypes t, int d, int s, bool notnull)

	Expr (const SQLTypeInfo &ti, bool has_agg=false)

virtual	~Expr ()

std::shared_ptr< Analyzer::Expr >	get_shared_ptr ()

const SQLTypeInfo &	get_type_info () const

void	set_type_info (const SQLTypeInfo &ti)

bool	get_contains_agg () const

void	set_contains_agg (bool a)

virtual std::shared_ptr < Analyzer::Expr >	add_cast (const SQLTypeInfo &new_type_info)

virtual void	check_group_by (const std::list< std::shared_ptr< Analyzer::Expr >> &groupby) const

virtual std::shared_ptr < Analyzer::Expr >	normalize_simple_predicate (int &rte_idx) const

virtual void	group_predicates (std::list< const Expr * > &scan_predicates, std::list< const Expr * > &join_predicates, std::list< const Expr * > &const_predicates) const

virtual void	collect_rte_idx (std::set< int > &rte_idx_set) const

virtual void	collect_column_var (std::set< const ColumnVar , bool()(const ColumnVar , const ColumnVar )> &colvar_set, bool include_agg) const

virtual size_t	get_num_column_vars (const bool include_agg) const

virtual std::shared_ptr < Analyzer::Expr >	rewrite_with_targetlist (const std::vector< std::shared_ptr< TargetEntry >> &tlist) const

virtual std::shared_ptr < Analyzer::Expr >	rewrite_with_child_targetlist (const std::vector< std::shared_ptr< TargetEntry >> &tlist) const

virtual std::shared_ptr < Analyzer::Expr >	rewrite_agg_to_var (const std::vector< std::shared_ptr< TargetEntry >> &tlist) const

virtual void	print () const

virtual void	add_unique (std::list< const Expr * > &expr_list) const

virtual void	find_expr (std::function< bool(const Expr )> f, std::list< const Expr > &expr_list) const

std::shared_ptr< Analyzer::Expr >	decompress ()

virtual void	get_domain (DomainSet &domain_set) const

Static Public Member Functions
static bool	isFramingAvailableWindowFunc (SqlWindowFunctionKind kind)

Static Public Attributes
static constexpr std::array < SqlWindowFunctionKind, 11 >	FRAMING_ALLOWED_WINDOW_FUNCS

static constexpr std::array < SqlWindowFunctionKind, 8 >	AGGREGATION_TREE_REQUIRED_WINDOW_FUNCS_FOR_FRAMING

static constexpr std::array < SqlWindowFunctionKind, 3 >	REQUIRE_HASH_TABLE_FOR_FRAMING

Private Attributes
const SqlWindowFunctionKind	kind_

const std::vector < std::shared_ptr < Analyzer::Expr > >	args_

const std::vector < std::shared_ptr < Analyzer::Expr > >	partition_keys_

const std::vector < std::shared_ptr < Analyzer::Expr > >	order_keys_

const FrameBoundType	frame_bound_type_ {FrameBoundType::NONE}

const std::shared_ptr < Analyzer::Expr >	frame_start_bound_

const std::shared_ptr < Analyzer::Expr >	frame_end_bound_

const std::vector< OrderEntry >	collation_

Additional Inherited Members
Protected Attributes inherited from Analyzer::Expr
SQLTypeInfo	type_info

bool	contains_agg

Detailed Description

Definition at line 2522 of file Analyzer.h.

Member Enumeration Documentation

enum Analyzer::WindowFunction::FrameBoundType

strong

Enumerator
NONE
ROW
RANGE

Definition at line 2524 of file Analyzer.h.

2524 { NONE, ROW, RANGE };

AggregationType::NONE

Constructor & Destructor Documentation

Analyzer::WindowFunction::WindowFunction	(	const SQLTypeInfo &	ti,
		const SqlWindowFunctionKind	kind,
		const std::vector< std::shared_ptr< Analyzer::Expr >> &	args,
		const std::vector< std::shared_ptr< Analyzer::Expr >> &	partition_keys,
		const std::vector< std::shared_ptr< Analyzer::Expr >> &	order_keys,
		const FrameBoundType	frame_bound_type,
		const std::shared_ptr< Expr >	frame_start_bound,
		const std::shared_ptr< Expr >	frame_end_bound,
		const std::vector< OrderEntry > &	collation
	)

inline

Definition at line 2552 of file Analyzer.h.

       : Expr(ti)
       , kind_(kind)
       , args_(args)
       , partition_keys_(partition_keys)
       , order_keys_(order_keys)
       , frame_bound_type_(frame_bound_type)
       , frame_start_bound_(frame_start_bound)
       , frame_end_bound_(frame_end_bound)
       , collation_(collation){};

Member Function Documentation

std::shared_ptr< Analyzer::Expr > Analyzer::WindowFunction::deep_copy ( ) const

overridevirtual

Implements Analyzer::Expr.

Definition at line 222 of file Analyzer.cpp.

References args_, collation_, frame_bound_type_, frame_end_bound_, frame_start_bound_, kind_, order_keys_, partition_keys_, and Analyzer::Expr::type_info.

                                                             {
   return makeExpr<WindowFunction>(type_info,
                                   kind_,
                                   args_,
                                   partition_keys_,
                                   order_keys_,
                                   frame_bound_type_,
                                   frame_start_bound_->deep_copy(),
                                   frame_end_bound_->deep_copy(),
                                   collation_);
 }

const std::vector<std::shared_ptr<Analyzer::Expr> >& Analyzer::WindowFunction::getArgs ( ) const

inline

Definition at line 2578 of file Analyzer.h.

References args_.

Referenced by CodeGenerator::codegenFixedLengthColVarInWindow(), WindowFunctionContext::compute(), WindowFunctionContext::computeAggregateTreeCacheKey(), WindowFunctionContext::computePartitionBuffer(), RelAlgExecutor::createWindowFunctionContext(), anonymous_namespace{WindowFunctionIR.cpp}::get_adjusted_window_type_info(), anonymous_namespace{WindowContext.cpp}::get_lag_or_lead_argument(), ScalarExprToSql::visitWindowFunction(), DeepCopyVisitor::visitWindowFunction(), ScalarExprVisitor< std::set< shared::TableKey > >::visitWindowFunction(), and anonymous_namespace{WindowExpressionRewrite.cpp}::window_sum_and_count_match().

2578 { return args_; }

Analyzer::WindowFunction::args_

const std::vector< std::shared_ptr< Analyzer::Expr > > args_

Definition: Analyzer.h:2639

Here is the caller graph for this function:

const std::vector<OrderEntry>& Analyzer::WindowFunction::getCollation ( ) const

inline

Definition at line 2602 of file Analyzer.h.

References collation_.

Referenced by WindowFunctionContext::computeAggregateTreeCacheKey(), WindowFunctionContext::createComparator(), RelAlgExecutor::createWindowFunctionContext(), ScalarExprToSql::visitWindowFunction(), and DeepCopyVisitor::visitWindowFunction().

2602 { return collation_; }

Analyzer::WindowFunction::collation_

const std::vector< OrderEntry > collation_

Definition: Analyzer.h:2645

Here is the caller graph for this function:

Analyzer::WindowFunction::FrameBoundType Analyzer::WindowFunction::getFrameBoundType ( ) const

inline

Definition at line 2604 of file Analyzer.h.

References frame_bound_type_.

Referenced by DeepCopyVisitor::visitWindowFunction().

                                                                  {
     return frame_bound_type_;
   }

Here is the caller graph for this function:

const Analyzer::WindowFrame* Analyzer::WindowFunction::getFrameEndBound ( ) const

inline

Definition at line 2595 of file Analyzer.h.

References CHECK, and frame_end_bound_.

Referenced by Executor::codegenFrameBoundRange(), and DeepCopyVisitor::visitWindowFunction().

                                                       {
     std::shared_ptr<WindowFrame> frame_end_bound =
         std::dynamic_pointer_cast<WindowFrame>(frame_end_bound_);
     CHECK(frame_end_bound);
     return frame_end_bound.get();
   }

Here is the caller graph for this function:

const Analyzer::WindowFrame* Analyzer::WindowFunction::getFrameStartBound ( ) const

inline

Definition at line 2588 of file Analyzer.h.

References CHECK, and frame_start_bound_.

Referenced by Executor::codegenFrameBoundRange(), and DeepCopyVisitor::visitWindowFunction().

                                                         {
     std::shared_ptr<WindowFrame> frame_start_bound =
         std::dynamic_pointer_cast<WindowFrame>(frame_start_bound_);
     CHECK(frame_start_bound);
     return frame_start_bound.get();
   }

Here is the caller graph for this function:

SqlWindowFunctionKind Analyzer::WindowFunction::getKind ( ) const

inline

Definition at line 2576 of file Analyzer.h.

References kind_.

Referenced by WindowFunctionContext::aggregateState(), WindowFunctionContext::aggregateStateCount(), WindowFunctionContext::aggregateStatePendingOutputs(), Executor::codegenAggregateWindowState(), CodeGenerator::codegenFixedLengthColVarInWindow(), GroupByAndAggregate::codegenWindowRowPointer(), WindowFunctionContext::compute(), WindowFunctionContext::computeAggregateTreeCacheKey(), WindowFunctionContext::computePartitionBuffer(), anonymous_namespace{WindowFunctionIR.cpp}::get_adjusted_window_type_info(), anonymous_namespace{WindowContext.cpp}::get_lag_or_lead_argument(), anonymous_namespace{WindowContext.cpp}::get_target_idx_for_first_or_last_value_func(), ScalarExprToSql::visitWindowFunction(), DeepCopyVisitor::visitWindowFunction(), window_function_requires_peer_handling(), and WindowFunctionContext::WindowFunctionContext().

2576 { return kind_; }

Analyzer::WindowFunction::kind_

const SqlWindowFunctionKind kind_

Definition: Analyzer.h:2638

Here is the caller graph for this function:

const std::vector<std::shared_ptr<Analyzer::Expr> >& Analyzer::WindowFunction::getOrderKeys ( ) const

inline

Definition at line 2584 of file Analyzer.h.

References order_keys_.

Referenced by Executor::codegenFrameBoundExpr(), Executor::codegenLoadCurrentValueFromColBuf(), Executor::codegenLoadOrderKeyBufPtr(), WindowFunctionContext::compute(), WindowFunctionContext::computeAggregateTreeCacheKey(), WindowFunctionContext::createComparator(), RelAlgExecutor::createWindowFunctionContext(), Executor::getFirstOrderColTypeInfo(), Executor::getOrderKeyTypeName(), ScalarExprToSql::visitWindowFunction(), DeepCopyVisitor::visitWindowFunction(), ScalarExprVisitor< std::set< shared::TableKey > >::visitWindowFunction(), and window_function_requires_peer_handling().

                                                                      {
     return order_keys_;
   }

Here is the caller graph for this function:

const std::vector<std::shared_ptr<Analyzer::Expr> >& Analyzer::WindowFunction::getPartitionKeys ( ) const

inline

Definition at line 2580 of file Analyzer.h.

References partition_keys_.

Referenced by WindowFunctionContext::computeAggregateTreeCacheKey(), RelAlgExecutor::computeWindow(), ScalarExprToSql::visitWindowFunction(), DeepCopyVisitor::visitWindowFunction(), and ScalarExprVisitor< std::set< shared::TableKey > >::visitWindowFunction().

                                                                          {
     return partition_keys_;
   }

Here is the caller graph for this function:

bool Analyzer::WindowFunction::hasAggregateTreeRequiredWindowFunc ( ) const

inline

Definition at line 2624 of file Analyzer.h.

References AGGREGATION_TREE_REQUIRED_WINDOW_FUNCS_FOR_FRAMING, anonymous_namespace{QueryMemoryDescriptor.cpp}::any_of(), and kind_.

Referenced by WindowFunctionContext::needsToBuildAggregateTree().

                                                   {
     return std::any_of(
         AGGREGATION_TREE_REQUIRED_WINDOW_FUNCS_FOR_FRAMING.begin(),
         AGGREGATION_TREE_REQUIRED_WINDOW_FUNCS_FOR_FRAMING.end(),
         [this](SqlWindowFunctionKind target_kind) { return kind_ == target_kind; });
   }

Here is the call graph for this function:

Here is the caller graph for this function:

bool Analyzer::WindowFunction::hasFraming ( ) const

inline

Definition at line 2612 of file Analyzer.h.

References frame_bound_type_, isFramingAvailableWindowFunc(), kind_, and NONE.

Referenced by WindowFunctionContext::compute(), WindowFunctionContext::needsToBuildAggregateTree(), toString(), and WindowFunctionContext::WindowFunctionContext().

                           {
     return frame_bound_type_ != FrameBoundType::NONE &&
            isFramingAvailableWindowFunc(kind_);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

bool Analyzer::WindowFunction::hasRangeModeFraming ( ) const

inline

Definition at line 2610 of file Analyzer.h.

References frame_bound_type_, and RANGE.

Referenced by CodeGenerator::codegenFixedLengthColVar(), and Executor::codegenFrameBoundExpr().

2610 { return frame_bound_type_ == FrameBoundType::RANGE; }

Analyzer::WindowFunction::frame_bound_type_

const FrameBoundType frame_bound_type_

Definition: Analyzer.h:2642

Analyzer::WindowFunction::FrameBoundType::RANGE

Here is the caller graph for this function:

bool Analyzer::WindowFunction::hasRowModeFraming ( ) const

inline

Definition at line 2608 of file Analyzer.h.

References frame_bound_type_, and ROW.

2608 { return frame_bound_type_ == FrameBoundType::ROW; }

Analyzer::WindowFunction::frame_bound_type_

const FrameBoundType frame_bound_type_

Definition: Analyzer.h:2642

Analyzer::WindowFunction::FrameBoundType::ROW

bool Analyzer::WindowFunction::isFrameNavigateWindowFunction ( ) const

inline

Definition at line 2630 of file Analyzer.h.

References anonymous_namespace{QueryMemoryDescriptor.cpp}::any_of(), kind_, and REQUIRE_HASH_TABLE_FOR_FRAMING.

Referenced by Executor::codegenCurrentPartitionIndex(), Executor::codegenLoadCurrentValueFromColBuf(), and RelAlgExecutor::createWindowFunctionContext().

                                              {
     return std::any_of(
         REQUIRE_HASH_TABLE_FOR_FRAMING.begin(),
         REQUIRE_HASH_TABLE_FOR_FRAMING.end(),
         [this](SqlWindowFunctionKind target_kind) { return kind_ == target_kind; });
   }

Here is the call graph for this function:

Here is the caller graph for this function:

static bool Analyzer::WindowFunction::isFramingAvailableWindowFunc ( SqlWindowFunctionKind kind )

inlinestatic

Definition at line 2617 of file Analyzer.h.

References anonymous_namespace{QueryMemoryDescriptor.cpp}::any_of(), and FRAMING_ALLOWED_WINDOW_FUNCS.

Referenced by hasFraming(), and RelAlgTranslator::translateWindowFunction().

                                                                        {
     return std::any_of(
         FRAMING_ALLOWED_WINDOW_FUNCS.begin(),
         FRAMING_ALLOWED_WINDOW_FUNCS.end(),
         [kind](SqlWindowFunctionKind target_kind) { return kind == target_kind; });
   }

Here is the call graph for this function:

Here is the caller graph for this function:

bool Analyzer::WindowFunction::operator== ( const Expr & rhs ) const

overridevirtual

Implements Analyzer::Expr.

Definition at line 2548 of file Analyzer.cpp.

References args_, expr_list_match(), frame_bound_type_, frame_end_bound_, frame_start_bound_, kind_, order_keys_, and partition_keys_.

                                                      {
   const auto rhs_window = dynamic_cast<const WindowFunction*>(&rhs);
   if (!rhs_window) {
     return false;
   }
   if (kind_ != rhs_window->kind_ || args_.size() != rhs_window->args_.size() ||
       partition_keys_.size() != rhs_window->partition_keys_.size() ||
       order_keys_.size() != rhs_window->order_keys_.size() ||
       frame_bound_type_ != rhs_window->frame_bound_type_ ||
       frame_start_bound_.get() != rhs_window->frame_start_bound_.get() ||
       frame_end_bound_.get() != rhs_window->frame_end_bound_.get()) {
     return false;
   }
   return expr_list_match(args_, rhs_window->args_) &&
          expr_list_match(partition_keys_, rhs_window->partition_keys_) &&
          expr_list_match(order_keys_, rhs_window->order_keys_);
 }

Here is the call graph for this function:

std::string Analyzer::WindowFunction::toString ( ) const

overridevirtual

Implements Analyzer::Expr.

Definition at line 2985 of file Analyzer.cpp.

References args_, frame_bound_type_, frame_end_bound_, frame_start_bound_, hasFraming(), kind_, order_keys_, RANGE, run_benchmark_import::result, ROW, and UNREACHABLE.

                                          {
   std::string result = "WindowFunction(" + ::toString(kind_);
   for (const auto& arg : args_) {
     result += " " + arg->toString();
   }
   if (hasFraming()) {
     result += " Frame{";
     switch (frame_bound_type_) {
       case FrameBoundType::ROW: {
         result += "ROW";
         break;
       }
       case FrameBoundType::RANGE: {
         result += "RANGE";
         break;
       }
       default: {
         UNREACHABLE()
             << "Two bound types are supported for window framing: ROW and RANGE.";
         break;
       }
     }
     result += " BETWEEN : " + frame_start_bound_->toString();
     result += " AND : " + frame_end_bound_->toString();
   } else {
     if (!order_keys_.empty()) {
       result += " (RANGE BETWEEN UNBOUNDED PRECEDING AND CURRENT ROW)";
     } else {
       result += " (RANGE BETWEEN UNBOUNDED PRECEDING AND UNBOUNDED FOLLOWING)";
     }
   }
   result += "} ";
   return result + ") ";
 }

Here is the call graph for this function:

Member Data Documentation

constexpr std::array<SqlWindowFunctionKind, 8> Analyzer::WindowFunction::AGGREGATION_TREE_REQUIRED_WINDOW_FUNCS_FOR_FRAMING

static

Initial value:

{
          SqlWindowFunctionKind::SUM,
          SqlWindowFunctionKind::SUM_IF,
          SqlWindowFunctionKind::SUM_INTERNAL,
          SqlWindowFunctionKind::AVG,
          SqlWindowFunctionKind::MIN,
          SqlWindowFunctionKind::MAX,
          SqlWindowFunctionKind::COUNT,
          SqlWindowFunctionKind::COUNT_IF}

Definition at line 2538 of file Analyzer.h.

Referenced by hasAggregateTreeRequiredWindowFunc().

const std::vector<std::shared_ptr<Analyzer::Expr> > Analyzer::WindowFunction::args_

private

Definition at line 2639 of file Analyzer.h.

Referenced by deep_copy(), getArgs(), operator==(), and toString().

const std::vector<OrderEntry> Analyzer::WindowFunction::collation_

private

Definition at line 2645 of file Analyzer.h.

Referenced by deep_copy(), and getCollation().

const FrameBoundType Analyzer::WindowFunction::frame_bound_type_ {FrameBoundType::NONE}

private

Definition at line 2642 of file Analyzer.h.

Referenced by deep_copy(), getFrameBoundType(), hasFraming(), hasRangeModeFraming(), hasRowModeFraming(), operator==(), and toString().

const std::shared_ptr<Analyzer::Expr> Analyzer::WindowFunction::frame_end_bound_

private

Definition at line 2644 of file Analyzer.h.

Referenced by deep_copy(), getFrameEndBound(), operator==(), and toString().

const std::shared_ptr<Analyzer::Expr> Analyzer::WindowFunction::frame_start_bound_

private

Definition at line 2643 of file Analyzer.h.

Referenced by deep_copy(), getFrameStartBound(), operator==(), and toString().

constexpr std::array<SqlWindowFunctionKind, 11> Analyzer::WindowFunction::FRAMING_ALLOWED_WINDOW_FUNCS

static

Initial value:

{
      SqlWindowFunctionKind::SUM,
      SqlWindowFunctionKind::SUM_IF,
      SqlWindowFunctionKind::SUM_INTERNAL,
      SqlWindowFunctionKind::AVG,
      SqlWindowFunctionKind::MIN,
      SqlWindowFunctionKind::MAX,
      SqlWindowFunctionKind::COUNT,
      SqlWindowFunctionKind::COUNT_IF,
      SqlWindowFunctionKind::LAG_IN_FRAME,
      SqlWindowFunctionKind::LEAD_IN_FRAME,
      SqlWindowFunctionKind::NTH_VALUE_IN_FRAME}

Definition at line 2525 of file Analyzer.h.

Referenced by isFramingAvailableWindowFunc().

const SqlWindowFunctionKind Analyzer::WindowFunction::kind_

private

Definition at line 2638 of file Analyzer.h.

Referenced by deep_copy(), getKind(), hasAggregateTreeRequiredWindowFunc(), hasFraming(), isFrameNavigateWindowFunction(), operator==(), and toString().

const std::vector<std::shared_ptr<Analyzer::Expr> > Analyzer::WindowFunction::order_keys_

private

Definition at line 2641 of file Analyzer.h.

Referenced by deep_copy(), getOrderKeys(), operator==(), and toString().

const std::vector<std::shared_ptr<Analyzer::Expr> > Analyzer::WindowFunction::partition_keys_

private

Definition at line 2640 of file Analyzer.h.

Referenced by deep_copy(), getPartitionKeys(), and operator==().

constexpr std::array<SqlWindowFunctionKind, 3> Analyzer::WindowFunction::REQUIRE_HASH_TABLE_FOR_FRAMING

static

Initial value:

{
      SqlWindowFunctionKind::LAG_IN_FRAME,
      SqlWindowFunctionKind::LEAD_IN_FRAME,
      SqlWindowFunctionKind::NTH_VALUE_IN_FRAME}

Definition at line 2547 of file Analyzer.h.

Referenced by isFrameNavigateWindowFunction().

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

/home/jenkins-slave/workspace/core-os-doxygen/Analyzer/Analyzer.h
/home/jenkins-slave/workspace/core-os-doxygen/Analyzer/Analyzer.cpp

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation