org.apache.druid.sql.calcite.parser

Class DruidSqlParserUtils

java.lang.Object

org.apache.druid.sql.calcite.parser.DruidSqlParserUtils

public class DruidSqlParserUtils
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static String	ALL

Constructor Summary

Constructors

Constructor and Description
DruidSqlParserUtils()

Method Summary

Modifier and Type	Method and Description
static org.apache.calcite.sql.SqlOrderBy	convertClusterByToOrderBy(org.apache.calcite.sql.SqlNode query, org.apache.calcite.sql.SqlNodeList clusteredByList) Extracts and converts the information in the CLUSTERED BY clause to a new SqlOrderBy node.
static DimFilter	convertQueryToDimFilter(org.apache.calcite.sql.SqlNode replaceTimeQuery, org.joda.time.DateTimeZone dateTimeZone) This method is used to convert an SqlNode representing a query into a DimFilter for the same query.
static Granularity	convertSqlNodeToGranularity(org.apache.calcite.sql.SqlNode sqlNode) This method is used to extract the granularity from a SqlNode representing following function calls: 1.
static Granularity	convertSqlNodeToGranularityThrowingParseExceptions(org.apache.calcite.sql.SqlNode sqlNode) Delegates to convertSqlNodeToGranularity and converts the exceptions to ParseException with the underlying message
static String	parseColumnName(org.apache.calcite.sql.SqlNode sqlNode) Converts a SqlNode identifier into a string representation
static String	parseTimeStampWithTimeZone(org.apache.calcite.sql.SqlNode sqlNode, org.joda.time.DateTimeZone timeZone) Converts a SqlNode into a timestamp, taking into account the timezone
static void	throwIfUnsupportedGranularityInPartitionedBy(Granularity granularity) Throws an IAE with appropriate message if the granularity supplied is not present in Granularities.
static List<String>	validateQueryAndConvertToIntervals(org.apache.calcite.sql.SqlNode replaceTimeQuery, Granularity granularity, org.joda.time.DateTimeZone dateTimeZone) This method validates and converts a SqlNode representing a query into an optmizied list of intervals to be used in creating an ingestion spec.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ALL

public static final String ALL

See Also:

Constant Field Values

Constructor Detail

DruidSqlParserUtils

public DruidSqlParserUtils()

Method Detail

convertSqlNodeToGranularityThrowingParseExceptions

public static Granularity convertSqlNodeToGranularityThrowingParseExceptions(org.apache.calcite.sql.SqlNode sqlNode)
                                                                      throws ParseException

Delegates to convertSqlNodeToGranularity and converts the exceptions to ParseException with the underlying message

Throws:

ParseException

convertSqlNodeToGranularity

public static Granularity convertSqlNodeToGranularity(org.apache.calcite.sql.SqlNode sqlNode)
                                               throws ParseException

This method is used to extract the granularity from a SqlNode representing following function calls: 1. FLOOR(__time TO TimeUnit) 2. TIME_FLOOR(__time, 'PT1H') Validation on the sqlNode is contingent to following conditions: 1. sqlNode is an instance of SqlCall 2. Operator is either one of TIME_FLOOR or FLOOR 3. Number of operands in the call are 2 4. First operand is a SimpleIdentifier representing __time 5. If operator is TIME_FLOOR, the second argument is a literal, and can be converted to the Granularity class 6. If operator is FLOOR, the second argument is a TimeUnit, and can be mapped using TimeUnits Since it is to be used primarily while parsing the SqlNode, it is wrapped in convertSqlNodeToGranularityThrowingParseExceptions

Parameters:

sqlNode - SqlNode representing a call to a function

Returns:

Granularity as intended by the function call

Throws:

ParseException - SqlNode cannot be converted a granularity

validateQueryAndConvertToIntervals

public static List<String> validateQueryAndConvertToIntervals(org.apache.calcite.sql.SqlNode replaceTimeQuery,
                                                              Granularity granularity,
                                                              org.joda.time.DateTimeZone dateTimeZone)
                                                       throws org.apache.calcite.tools.ValidationException

This method validates and converts a SqlNode representing a query into an optmizied list of intervals to be used in creating an ingestion spec. If the sqlNode is an SqlLiteral of ALL, returns a singleton list of "ALL". Otherwise, it converts and optimizes the query using MoveTimeFiltersToIntervals into a list of intervals which contain all valid values of time as per the query. The following validations are performed 1. Only __time column and timestamp literals are present in the query 2. The interval after optimization is not empty 3. The operands in the expression are supported 4. The intervals after adjusting for timezone are aligned with the granularity parameter

Parameters:

replaceTimeQuery - Sql node representing the query

granularity - granularity of the query for validation

dateTimeZone - timezone

Returns:

List of string representation of intervals

Throws:

org.apache.calcite.tools.ValidationException - if the SqlNode cannot be converted to a list of intervals

convertClusterByToOrderBy

public static org.apache.calcite.sql.SqlOrderBy convertClusterByToOrderBy(org.apache.calcite.sql.SqlNode query,
                                                                          org.apache.calcite.sql.SqlNodeList clusteredByList)

Extracts and converts the information in the CLUSTERED BY clause to a new SqlOrderBy node.

Parameters:

query - sql query

clusteredByList - List of clustered by columns

Returns:

SqlOrderBy node containing the clusteredByList information

convertQueryToDimFilter

public static DimFilter convertQueryToDimFilter(org.apache.calcite.sql.SqlNode replaceTimeQuery,
                                                org.joda.time.DateTimeZone dateTimeZone)
                                         throws org.apache.calcite.tools.ValidationException

This method is used to convert an SqlNode representing a query into a DimFilter for the same query. It takes the timezone as a separate parameter, as Sql timestamps don't contain that information. Supported functions are AND, OR, NOT, >, <, >=, <= and BETWEEN operators in the sql query.

Parameters:

replaceTimeQuery - Sql node representing the query

dateTimeZone - timezone

Returns:

Dimfilter for the query

Throws:

org.apache.calcite.tools.ValidationException - if the SqlNode cannot be converted a Dimfilter

parseColumnName

public static String parseColumnName(org.apache.calcite.sql.SqlNode sqlNode)
                              throws org.apache.calcite.tools.ValidationException

Converts a SqlNode identifier into a string representation

Parameters:

sqlNode - the sql node

Returns:

string representing the column name

Throws:

org.apache.calcite.tools.ValidationException - if the sql node is not an SqlIdentifier

parseTimeStampWithTimeZone

public static String parseTimeStampWithTimeZone(org.apache.calcite.sql.SqlNode sqlNode,
                                                org.joda.time.DateTimeZone timeZone)
                                         throws org.apache.calcite.tools.ValidationException

Converts a SqlNode into a timestamp, taking into account the timezone

Parameters:

sqlNode - the sql node

timeZone - timezone

Returns:

the timestamp string as milliseconds from epoch

Throws:

org.apache.calcite.tools.ValidationException - if the sql node is not a SqlTimestampLiteral

throwIfUnsupportedGranularityInPartitionedBy

public static void throwIfUnsupportedGranularityInPartitionedBy(Granularity granularity)

Throws an IAE with appropriate message if the granularity supplied is not present in Granularities. It also filters out NONE as it is not a valid granularity that can be supplied in PARTITIONED BY