sqldefs.h File Reference

Common Enum definitions for SQL processing. More...

#include <string>
#include "Logger/Logger.h"

Include dependency graph for sqldefs.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	IS_COMPARISON(X)
#define	IS_LOGIC(X)   ((X) == kAND || (X) == kOR)
#define	IS_ARITHMETIC(X)   ((X) == kMINUS || (X) == kPLUS || (X) == kMULTIPLY || (X) == kDIVIDE || (X) == kMODULO)
#define	COMMUTE_COMPARISON(X)   ((X) == kLT ? kGT : (X) == kLE ? kGE : (X) == kGT ? kLT : (X) == kGE ? kLE : (X))
#define	IS_UNARY(X)
#define	IS_EQUIVALENCE(X)   ((X) == kEQ || (X) == kBW_EQ || (X) == kOVERLAPS)

Enumerations
enum	SQLOps {   kEQ = 0, kBW_EQ, kNE, kLT,   kGT, kLE, kGE, kAND,   kOR, kNOT, kMINUS, kPLUS,   kMULTIPLY, kDIVIDE, kMODULO, kUMINUS,   kISNULL, kISNOTNULL, kEXISTS, kCAST,   kARRAY_AT, kUNNEST, kFUNCTION, kIN,   kOVERLAPS, kENCODE_TEXT }
enum	SQLQualifier { kONE, kANY, kALL }
enum	SQLAgg {   kAVG, kMIN, kMAX, kSUM,   kCOUNT, kAPPROX_COUNT_DISTINCT, kAPPROX_QUANTILE, kSAMPLE,   kSINGLE_VALUE }
enum	SqlStringOpKind {   SqlStringOpKind::LOWER = 1, SqlStringOpKind::UPPER, SqlStringOpKind::INITCAP, SqlStringOpKind::REVERSE,   SqlStringOpKind::REPEAT, SqlStringOpKind::CONCAT, SqlStringOpKind::RCONCAT, SqlStringOpKind::LPAD,   SqlStringOpKind::RPAD, SqlStringOpKind::TRIM, SqlStringOpKind::LTRIM, SqlStringOpKind::RTRIM,   SqlStringOpKind::SUBSTRING, SqlStringOpKind::OVERLAY, SqlStringOpKind::REPLACE, SqlStringOpKind::SPLIT_PART,   SqlStringOpKind::REGEXP_REPLACE, SqlStringOpKind::REGEXP_SUBSTR, SqlStringOpKind::INVALID }
enum	SqlWindowFunctionKind {   SqlWindowFunctionKind::MIN = 1, SqlWindowFunctionKind::MAX, SqlWindowFunctionKind::AVG, SqlWindowFunctionKind::SUM,   SqlWindowFunctionKind::COUNT, SqlWindowFunctionKind::FIRST_EXPR, SqlWindowFunctionKind::LAST_EXPR, SqlWindowFunctionKind::NTH_EXPR,   SqlWindowFunctionKind::ROW_NUMBER, SqlWindowFunctionKind::RANK, SqlWindowFunctionKind::DENSE_RANK, SqlWindowFunctionKind::PERCENT_RANK,   SqlWindowFunctionKind::CUME_DIST, SqlWindowFunctionKind::NTILE, SqlWindowFunctionKind::LAG, SqlWindowFunctionKind::LEAD,   SqlWindowFunctionKind::FIRST_VALUE, SqlWindowFunctionKind::LAST_VALUE, SqlWindowFunctionKind::SUM_INTERNAL }
enum	SqlWindowFrameBoundType {   SqlWindowFrameBoundType::UNBOUNDED_PRECEDING = 1, SqlWindowFrameBoundType::EXPR_PRECEDING, SqlWindowFrameBoundType::CURRENT_ROW, SqlWindowFrameBoundType::EXPR_FOLLOWING,   SqlWindowFrameBoundType::UNBOUNDED_FOLLOWING, SqlWindowFrameBoundType::UNKNOWN }
enum	SQLStmtType {   kSELECT, kUPDATE, kINSERT, kDELETE,   kCREATE_TABLE }
enum	StorageOption { kDISK = 0, kGPU = 1, kCPU = 2 }
enum	ViewRefreshOption { kMANUAL = 0, kAUTO = 1, kIMMEDIATE = 2 }
enum	JoinType {   JoinType::INNER, JoinType::LEFT, JoinType::SEMI, JoinType::ANTI,   JoinType::INVALID }

Functions
std::string	toString (const JoinType &join_type)
std::string	toString (const SQLQualifier &qualifier)
std::string	toString (const SQLAgg &kind)
std::string	toString (const SQLOps &op)
SqlStringOpKind	name_to_string_op_kind (const std::string &func_name)
std::string	toString (const SqlStringOpKind &kind)
std::string	toString (const SqlWindowFunctionKind &kind)
std::string	toString (const SqlWindowFrameBoundType &kind)

Detailed Description

Common Enum definitions for SQL processing.

Definition in file sqldefs.h.

Macro Definition Documentation

#define COMMUTE_COMPARISON

(

X

)

((X) == kLT ? kGT : (X) == kLE ? kGE : (X) == kGT ? kLT : (X) == kGE ? kLE : (X))

Definition at line 63 of file sqldefs.h.

Referenced by Analyzer::BinOper::normalize_simple_predicate().

#define IS_ARITHMETIC

(

X

)

((X) == kMINUS || (X) == kPLUS || (X) == kMULTIPLY || (X) == kDIVIDE || (X) == kMODULO)

Definition at line 61 of file sqldefs.h.

Referenced by Analyzer::BinOper::analyze_type_info(), CodeGenerator::codegen(), CodeGenerator::codegenArith(), and anonymous_namespace{ExpressionRewrite.cpp}::ConstantFoldingVisitor::foldOper().

#define IS_COMPARISON

(

X

)

Value:

((X) == kEQ || (X) == kBW_EQ || (X) == kOVERLAPS || (X) == kNE || (X) == kLT || \
   (X) == kGT || (X) == kLE || (X) == kGE)

Definition at line 57 of file sqldefs.h.

Referenced by Analyzer::BinOper::analyze_type_info(), anonymous_namespace{CompareIR.cpp}::check_array_comp_cond(), CodeGenerator::codegen(), CodeGenerator::codegenCmp(), anonymous_namespace{ExpressionRewrite.cpp}::ConstantFoldingVisitor::foldOper(), Parser::OperExpr::normalize(), Analyzer::BinOper::normalize_simple_predicate(), RelAlgTranslator::translateOper(), and anonymous_namespace{ExpressionRewrite.cpp}::ConstantFoldingVisitor::visitBinOper().

#define IS_EQUIVALENCE

(

X

)

((X) == kEQ || (X) == kBW_EQ || (X) == kOVERLAPS)

Definition at line 68 of file sqldefs.h.

Referenced by Executor::buildCurrentLevelHashTable(), anonymous_namespace{EquiJoinCondition.cpp}::can_combine_with(), anonymous_namespace{CompareIR.cpp}::check_array_comp_cond(), CodeGenerator::codegenCmp(), anonymous_namespace{FromTableReordering.cpp}::get_join_qual_cost(), PerfectJoinHashTable::getInstance(), CodeGenerator::hashJoinLhs(), anonymous_namespace{CompareIR.cpp}::make_eq(), and anonymous_namespace{QueryPlanDagExtractor.cpp}::IsEquivBinOp::operator()().

#define IS_LOGIC

(

X

)

((X) == kAND || (X) == kOR)

Definition at line 60 of file sqldefs.h.

Referenced by Analyzer::BinOper::analyze_type_info(), CodeGenerator::codegen(), CodeGenerator::codegenLogical(), and anonymous_namespace{ExpressionRewrite.cpp}::ConstantFoldingVisitor::foldOper().

#define IS_UNARY

(

X

)

Value:

((X) == kNOT || (X) == kUMINUS || (X) == kISNULL || (X) == kEXISTS || (X) == kCAST || \
   (X) == kENCODE_TEXT)

Definition at line 65 of file sqldefs.h.

Enumeration Type Documentation

enum JoinType

strong

Enumerator
INNER
LEFT
SEMI
ANTI
INVALID

Definition at line 151 of file sqldefs.h.

{ INNER, LEFT, SEMI, ANTI, INVALID };

enum SQLAgg

Enumerator
kAVG
kMIN
kMAX
kSUM
kCOUNT
kAPPROX_COUNT_DISTINCT
kAPPROX_QUANTILE
kSAMPLE
kSINGLE_VALUE

Definition at line 72 of file sqldefs.h.

            {
  kAVG,
  kMIN,
  kMAX,
  kSUM,
  kCOUNT,
  kAPPROX_COUNT_DISTINCT,
  kAPPROX_QUANTILE,
  kSAMPLE,
  kSINGLE_VALUE
};

enum SQLOps

Enumerator
kEQ
kBW_EQ
kNE
kLT
kGT
kLE
kGE
kAND
kOR
kNOT
kMINUS
kPLUS
kMULTIPLY
kDIVIDE
kMODULO
kUMINUS
kISNULL
kISNOTNULL
kEXISTS
kCAST
kARRAY_AT
kUNNEST
kFUNCTION
kIN
kOVERLAPS
kENCODE_TEXT

Definition at line 28 of file sqldefs.h.

            {
  kEQ = 0,
  kBW_EQ,
  kNE,
  kLT,
  kGT,
  kLE,
  kGE,
  kAND,
  kOR,
  kNOT,
  kMINUS,
  kPLUS,
  kMULTIPLY,
  kDIVIDE,
  kMODULO,
  kUMINUS,
  kISNULL,
  kISNOTNULL,
  kEXISTS,
  kCAST,
  kARRAY_AT,
  kUNNEST,
  kFUNCTION,
  kIN,
  kOVERLAPS,
  kENCODE_TEXT
};

enum SQLQualifier

Enumerator
kONE
kANY
kALL

Definition at line 70 of file sqldefs.h.

{ kONE, kANY, kALL };

enum SQLStmtType

Enumerator
kSELECT
kUPDATE
kINSERT
kDELETE
kCREATE_TABLE

Definition at line 145 of file sqldefs.h.

{ kSELECT, kUPDATE, kINSERT, kDELETE, kCREATE_TABLE };

enum SqlStringOpKind

strong

Enumerator
LOWER
UPPER
INITCAP
REVERSE
REPEAT
CONCAT
RCONCAT
LPAD
RPAD
TRIM
LTRIM
RTRIM
SUBSTRING
OVERLAY
REPLACE
SPLIT_PART
REGEXP_REPLACE
REGEXP_SUBSTR
INVALID

Definition at line 84 of file sqldefs.h.

                           {
  /* Unary */
  LOWER = 1,
  UPPER,
  INITCAP,
  REVERSE,
  /* Binary */
  REPEAT,
  CONCAT,
  RCONCAT,
  /* Ternary */
  LPAD,
  RPAD,
  TRIM,
  LTRIM,
  RTRIM,
  SUBSTRING,
  OVERLAY,
  REPLACE,
  SPLIT_PART,
  /* 6 args */
  REGEXP_REPLACE,
  REGEXP_SUBSTR,
  INVALID
};

enum SqlWindowFrameBoundType

strong

Enumerator
UNBOUNDED_PRECEDING
EXPR_PRECEDING
CURRENT_ROW
EXPR_FOLLOWING
UNBOUNDED_FOLLOWING
UNKNOWN

Definition at line 136 of file sqldefs.h.

                                   {
  UNBOUNDED_PRECEDING = 1,
  EXPR_PRECEDING,
  CURRENT_ROW,
  EXPR_FOLLOWING,
  UNBOUNDED_FOLLOWING,
  UNKNOWN
};

enum SqlWindowFunctionKind

strong

Enumerator
MIN
MAX
AVG
SUM
COUNT
FIRST_EXPR
LAST_EXPR
NTH_EXPR
ROW_NUMBER
RANK
DENSE_RANK
PERCENT_RANK
CUME_DIST
NTILE
LAG
LEAD
FIRST_VALUE
LAST_VALUE
SUM_INTERNAL

Definition at line 110 of file sqldefs.h.

                                 {
  // set MIN's enum val as one, and we use window function kind's enum vals
  // to classify a behavior of our runtime code for window framing
  // i.e., aggregate_##value_type##_values functions
  // todo (yoonmin): support FIRST_EXPR, LAST_EXPR, AND NTH_EXPR with framing
  MIN = 1,
  MAX,
  AVG,
  SUM,
  COUNT,
  FIRST_EXPR,
  LAST_EXPR,
  NTH_EXPR,
  ROW_NUMBER,
  RANK,
  DENSE_RANK,
  PERCENT_RANK,
  CUME_DIST,
  NTILE,
  LAG,
  LEAD,
  FIRST_VALUE,
  LAST_VALUE,
  SUM_INTERNAL  // For deserialization from Calcite only. Gets rewritten to a regular SUM.
};

enum StorageOption

Enumerator
kDISK
kGPU
kCPU

Definition at line 147 of file sqldefs.h.

{ kDISK = 0, kGPU = 1, kCPU = 2 };

enum ViewRefreshOption

Enumerator
kMANUAL
kAUTO
kIMMEDIATE

Definition at line 149 of file sqldefs.h.

{ kMANUAL = 0, kAUTO = 1, kIMMEDIATE = 2 };

Function Documentation

SqlStringOpKind name_to_string_op_kind ( const std::string &  func_name )

inline

Definition at line 270 of file sqldefs.h.

References CONCAT, logger::FATAL, INITCAP, INVALID, LOG, LOWER, LPAD, LTRIM, OVERLAY, REGEXP_REPLACE, REGEXP_SUBSTR, REPEAT, REPLACE, REVERSE, RPAD, RTRIM, SPLIT_PART, SUBSTRING, TRIM, and UPPER.

Referenced by RelAlgTranslator::translateStringOper().

                                                                          {
  if (func_name == "LOWER") {
    return SqlStringOpKind::LOWER;
  }
  if (func_name == "UPPER") {
    return SqlStringOpKind::UPPER;
  }
  if (func_name == "INITCAP") {
    return SqlStringOpKind::INITCAP;
  }
  if (func_name == "REVERSE") {
    return SqlStringOpKind::REVERSE;
  }
  if (func_name == "REPEAT") {
    return SqlStringOpKind::REPEAT;
  }
  if (func_name == "||") {
    return SqlStringOpKind::CONCAT;
  }
  if (func_name == "LPAD") {
    return SqlStringOpKind::LPAD;
  }
  if (func_name == "RPAD") {
    return SqlStringOpKind::RPAD;
  }
  if (func_name == "TRIM") {
    return SqlStringOpKind::TRIM;
  }
  if (func_name == "LTRIM") {
    return SqlStringOpKind::LTRIM;
  }
  if (func_name == "RTRIM") {
    return SqlStringOpKind::RTRIM;
  }
  if (func_name == "SUBSTRING") {
    return SqlStringOpKind::SUBSTRING;
  }
  if (func_name == "OVERLAY") {
    return SqlStringOpKind::OVERLAY;
  }
  if (func_name == "REPLACE") {
    return SqlStringOpKind::REPLACE;
  }
  if (func_name == "SPLIT_PART") {
    return SqlStringOpKind::SPLIT_PART;
  }
  if (func_name == "REGEXP_REPLACE") {
    return SqlStringOpKind::REGEXP_REPLACE;
  }
  if (func_name == "REGEXP_SUBSTR") {
    return SqlStringOpKind::REGEXP_SUBSTR;
  }
  if (func_name == "REGEXP_MATCH") {
    return SqlStringOpKind::REGEXP_SUBSTR;
  }
  LOG(FATAL) << "Invalid string function " << func_name << ".";
  return SqlStringOpKind::INVALID;
}

Here is the caller graph for this function:

std::string toString ( const JoinType &  join_type )

inline

Definition at line 158 of file sqldefs.h.

References ANTI, INNER, LEFT, and SEMI.

                                                     {
  switch (join_type) {
    case JoinType::INNER:
      return "INNER";
    case JoinType::LEFT:
      return "LEFT";
    case JoinType::SEMI:
      return "SEMI";
    case JoinType::ANTI:
      return "ANTI";
    default:
      return "INVALID";
  }
}

std::string toString ( const SQLQualifier &  qualifier )

inline

Definition at line 173 of file sqldefs.h.

References logger::FATAL, kALL, kANY, kONE, and LOG.

                                                         {
  switch (qualifier) {
    case kONE:
      return "ONE";
    case kANY:
      return "ANY";
    case kALL:
      return "ALL";
  }
  LOG(FATAL) << "Invalid SQLQualifier: " << qualifier;
  return "";
}

std::string toString ( const SQLAgg &  kind )

inline

Definition at line 186 of file sqldefs.h.

References logger::FATAL, kAPPROX_COUNT_DISTINCT, kAPPROX_QUANTILE, kAVG, kCOUNT, kMAX, kMIN, kSAMPLE, kSINGLE_VALUE, kSUM, and LOG.

                                              {
  switch (kind) {
    case kAVG:
      return "AVG";
    case kMIN:
      return "MIN";
    case kMAX:
      return "MAX";
    case kSUM:
      return "SUM";
    case kCOUNT:
      return "COUNT";
    case kAPPROX_COUNT_DISTINCT:
      return "APPROX_COUNT_DISTINCT";
    case kAPPROX_QUANTILE:
      return "APPROX_PERCENTILE";
    case kSAMPLE:
      return "SAMPLE";
    case kSINGLE_VALUE:
      return "SINGLE_VALUE";
  }
  LOG(FATAL) << "Invalid aggregate kind: " << kind;
  return "";
}

std::string toString ( const SQLOps &  op )

inline

Definition at line 211 of file sqldefs.h.

References logger::FATAL, kAND, kARRAY_AT, kBW_EQ, kCAST, kDIVIDE, kENCODE_TEXT, kEQ, kEXISTS, kFUNCTION, kGE, kGT, kIN, kISNOTNULL, kISNULL, kLE, kLT, kMINUS, kMODULO, kMULTIPLY, kNE, kNOT, kOR, kOVERLAPS, kPLUS, kUMINUS, kUNNEST, and LOG.

                                            {
  switch (op) {
    case kEQ:
      return "EQ";
    case kBW_EQ:
      return "BW_EQ";
    case kNE:
      return "NE";
    case kLT:
      return "LT";
    case kGT:
      return "GT";
    case kLE:
      return "LE";
    case kGE:
      return "GE";
    case kAND:
      return "AND";
    case kOR:
      return "OR";
    case kNOT:
      return "NOT";
    case kMINUS:
      return "MINUS";
    case kPLUS:
      return "PLUS";
    case kMULTIPLY:
      return "MULTIPLY";
    case kDIVIDE:
      return "DIVIDE";
    case kMODULO:
      return "MODULO";
    case kUMINUS:
      return "UMINUS";
    case kISNULL:
      return "ISNULL";
    case kISNOTNULL:
      return "ISNOTNULL";
    case kEXISTS:
      return "EXISTS";
    case kCAST:
      return "CAST";
    case kARRAY_AT:
      return "ARRAY_AT";
    case kUNNEST:
      return "UNNEST";
    case kFUNCTION:
      return "FUNCTION";
    case kIN:
      return "IN";
    case kOVERLAPS:
      return "OVERLAPS";
    case kENCODE_TEXT:
      return "ENCODE_TEXT";
  }
  LOG(FATAL) << "Invalid operation kind: " << op;
  return "";
}

std::string toString ( const SqlStringOpKind &  kind )

inline

Definition at line 329 of file sqldefs.h.

References CONCAT, logger::FATAL, INITCAP, LOG, LOWER, LPAD, LTRIM, OVERLAY, RCONCAT, REGEXP_REPLACE, REGEXP_SUBSTR, REPEAT, REPLACE, REVERSE, RPAD, RTRIM, SPLIT_PART, SUBSTRING, TRIM, and UPPER.

                                                       {
  switch (kind) {
    case SqlStringOpKind::LOWER:
      return "LOWER";
    case SqlStringOpKind::UPPER:
      return "UPPER";
    case SqlStringOpKind::INITCAP:
      return "INITCAP";
    case SqlStringOpKind::REVERSE:
      return "REVERSE";
    case SqlStringOpKind::REPEAT:
      return "REPEAT";
    case SqlStringOpKind::CONCAT:
    case SqlStringOpKind::RCONCAT:
      return "||";
    case SqlStringOpKind::LPAD:
      return "LPAD";
    case SqlStringOpKind::RPAD:
      return "RPAD";
    case SqlStringOpKind::TRIM:
      return "TRIM";
    case SqlStringOpKind::LTRIM:
      return "LTRIM";
    case SqlStringOpKind::RTRIM:
      return "RTRIM";
    case SqlStringOpKind::SUBSTRING:
      return "SUBSTRING";
    case SqlStringOpKind::OVERLAY:
      return "OVERLAY";
    case SqlStringOpKind::REPLACE:
      return "REPLACE";
    case SqlStringOpKind::SPLIT_PART:
      return "SPLIT_PART";
    case SqlStringOpKind::REGEXP_REPLACE:
      return "REGEXP_REPLACE";
    case SqlStringOpKind::REGEXP_SUBSTR:
      return "REGEXP_SUBSTR";
    default:
      LOG(FATAL) << "Invalid string operation";
  }
  return "";
}

std::string toString ( const SqlWindowFunctionKind &  kind )

inline

Definition at line 372 of file sqldefs.h.

References AVG, COUNT, CUME_DIST, DENSE_RANK, logger::FATAL, FIRST_EXPR, FIRST_VALUE, LAG, LAST_EXPR, LAST_VALUE, LEAD, LOG, MAX, MIN, NTH_EXPR, NTILE, PERCENT_RANK, RANK, ROW_NUMBER, SUM, and SUM_INTERNAL.

                                                             {
  switch (kind) {
    case SqlWindowFunctionKind::ROW_NUMBER:
      return "ROW_NUMBER";
    case SqlWindowFunctionKind::RANK:
      return "RANK";
    case SqlWindowFunctionKind::DENSE_RANK:
      return "DENSE_RANK";
    case SqlWindowFunctionKind::PERCENT_RANK:
      return "PERCENT_RANK";
    case SqlWindowFunctionKind::CUME_DIST:
      return "CUME_DIST";
    case SqlWindowFunctionKind::NTILE:
      return "NTILE";
    case SqlWindowFunctionKind::LAG:
      return "LAG";
    case SqlWindowFunctionKind::LEAD:
      return "LEAD";
    case SqlWindowFunctionKind::FIRST_VALUE:
      return "FIRST_VALUE";
    case SqlWindowFunctionKind::LAST_VALUE:
      return "LAST_VALUE";
    case SqlWindowFunctionKind::AVG:
      return "AVG";
    case SqlWindowFunctionKind::MIN:
      return "MIN";
    case SqlWindowFunctionKind::MAX:
      return "MAX";
    case SqlWindowFunctionKind::SUM:
      return "SUM";
    case SqlWindowFunctionKind::COUNT:
      return "COUNT";
    case SqlWindowFunctionKind::SUM_INTERNAL:
      return "SUM_INTERNAL";
    case SqlWindowFunctionKind::FIRST_EXPR:
      return "FIRST_EXPR";
    case SqlWindowFunctionKind::LAST_EXPR:
      return "LAST_EXPR";
    case SqlWindowFunctionKind::NTH_EXPR:
      return "NTH_EXPR";
  }
  LOG(FATAL) << "Invalid window function kind.";
  return "";
}

std::string toString ( const SqlWindowFrameBoundType &  kind )

inline

Definition at line 417 of file sqldefs.h.

References CURRENT_ROW, EXPR_FOLLOWING, EXPR_PRECEDING, logger::FATAL, LOG, UNBOUNDED_FOLLOWING, UNBOUNDED_PRECEDING, and UNKNOWN.

                                                               {
  switch (kind) {
    case SqlWindowFrameBoundType::UNBOUNDED_PRECEDING:
      return "UNBOUNDED_PRECEDING";
    case SqlWindowFrameBoundType::EXPR_PRECEDING:
      return "EXPR_PRECEDING";
    case SqlWindowFrameBoundType::CURRENT_ROW:
      return "CURRENT_ROW";
    case SqlWindowFrameBoundType::EXPR_FOLLOWING:
      return "EXPR_FOLLOWING";
    case SqlWindowFrameBoundType::UNBOUNDED_FOLLOWING:
      return "UNBOUNDED_FOLLOWING";
    case SqlWindowFrameBoundType::UNKNOWN:
      return "UNKNOWN";
  }
  LOG(FATAL) << "Invalid window function bound type.";
  return "";
}