org.apache.druid.sql.calcite.planner

Class Calcites

java.lang.Object

org.apache.druid.sql.calcite.planner.Calcites

public class Calcites
extends Object

Utility functions for Calcite.

See also the file saffron.properties which holds the character set system properties formerly set in this file.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Calcites.Arg0NullableArrayTypeInference
static class	Calcites.Arg1NullableArrayTypeInference

Field Summary

Fields

Modifier and Type	Field and Description
static org.apache.calcite.sql.type.SqlReturnTypeInference	ARG0_NULLABLE_ARRAY_RETURN_TYPE_INFERENCE
static org.apache.calcite.sql.type.SqlReturnTypeInference	ARG1_NULLABLE_ARRAY_RETURN_TYPE_INFERENCE

Method Summary

Modifier and Type	Method and Description
static org.joda.time.DateTime	calciteDateTimeLiteralToJoda(org.apache.calcite.rex.RexNode literal, org.joda.time.DateTimeZone timeZone) Translates "literal" (a TIMESTAMP or DATE literal) to milliseconds since the epoch using the provided session time zone.
static org.joda.time.DateTime	calciteDateToJoda(int date, org.joda.time.DateTimeZone timeZone) The inverse of jodaToCalciteDate(DateTime, DateTimeZone).
static org.joda.time.DateTime	calciteTimestampToJoda(long timestamp, org.joda.time.DateTimeZone timeZone) The inverse of jodaToCalciteTimestamp(DateTime, DateTimeZone).
static org.apache.calcite.rel.type.RelDataType	createSqlArrayTypeWithNullability(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory, org.apache.calcite.sql.type.SqlTypeName elementTypeName, boolean nullable) Like RelDataTypeFactory.createSqlTypeWithNullability, but creates types that align best with how Druid represents them.
static org.apache.calcite.rel.type.RelDataType	createSqlType(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory, org.apache.calcite.sql.type.SqlTypeName typeName) Like RelDataTypeFactory.createSqlType, but creates types that align best with how Druid represents them.
static org.apache.calcite.rel.type.RelDataType	createSqlTypeWithNullability(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory, org.apache.calcite.sql.type.SqlTypeName typeName, boolean nullable) Like RelDataTypeFactory.createSqlTypeWithNullability, but creates types that align best with how Druid represents them.
static Charset	defaultCharset()
static String	escapeStringLiteral(String s)
static String	findUnusedPrefixForDigits(String basePrefix, Iterable<String> strings) Find a string that is either equal to "basePrefix", or basePrefix prepended by underscores, and where nothing in "strings" starts with prefix plus a digit.
static ColumnType	getColumnTypeForRelDataType(org.apache.calcite.rel.type.RelDataType type) Convert RelDataType to the most appropriate ValueType Caller who want to coerce all ARRAY types to STRING can set `druid.expressions.allowArrayToStringCast` runtime property in ExpressionProcessingConfig
static StringComparator	getStringComparatorForRelDataType(org.apache.calcite.rel.type.RelDataType dataType)
static StringComparator	getStringComparatorForValueType(ColumnType valueType)
static ColumnType	getValueTypeForRelDataTypeFull(org.apache.calcite.rel.type.RelDataType type) Convert RelDataType to the most appropriate ValueType
static boolean	isDoubleType(org.apache.calcite.sql.type.SqlTypeName sqlTypeName)
static boolean	isLongType(org.apache.calcite.sql.type.SqlTypeName sqlTypeName)
static int	jodaToCalciteDate(org.joda.time.DateTime dateTime, org.joda.time.DateTimeZone timeZone) Calcite expects "DATE" types to be number of days from the epoch to the UTC date matching the local time fields.
static org.apache.calcite.util.DateString	jodaToCalciteDateString(org.joda.time.DateTime dateTime, org.joda.time.DateTimeZone timeZone) Calcite expects DATE literals to be represented by DateStrings in the local time zone.
static long	jodaToCalciteTimestamp(org.joda.time.DateTime dateTime, org.joda.time.DateTimeZone timeZone) Calcite expects "TIMESTAMP" types to be an instant that has the expected local time fields if printed as UTC.
static org.apache.calcite.rex.RexLiteral	jodaToCalciteTimestampLiteral(org.apache.calcite.rex.RexBuilder rexBuilder, org.joda.time.DateTime dateTime, org.joda.time.DateTimeZone sessionTimeZone, int precision) Creates a Calcite TIMESTAMP literal from a Joda DateTime.
static org.apache.calcite.util.TimeString	jodaToCalciteTimeString(org.joda.time.DateTime dateTime, org.joda.time.DateTimeZone timeZone) Calcite expects TIME literals to be represented by TimeStrings in the local time zone.
static String	makePrefixedName(String prefix, String suffix)
static Class<?>	sqlTypeNameJdbcToJavaClass(org.apache.calcite.sql.type.SqlTypeName typeName)

Methods inherited from class java.lang.Object

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

Field Detail

ARG0_NULLABLE_ARRAY_RETURN_TYPE_INFERENCE

public static final org.apache.calcite.sql.type.SqlReturnTypeInference ARG0_NULLABLE_ARRAY_RETURN_TYPE_INFERENCE

ARG1_NULLABLE_ARRAY_RETURN_TYPE_INFERENCE

public static final org.apache.calcite.sql.type.SqlReturnTypeInference ARG1_NULLABLE_ARRAY_RETURN_TYPE_INFERENCE

Method Detail

defaultCharset

public static Charset defaultCharset()

escapeStringLiteral

public static String escapeStringLiteral(String s)

getColumnTypeForRelDataType

@Nullable
public static ColumnType getColumnTypeForRelDataType(org.apache.calcite.rel.type.RelDataType type)

Convert RelDataType to the most appropriate ValueType Caller who want to coerce all ARRAY types to STRING can set `druid.expressions.allowArrayToStringCast` runtime property in ExpressionProcessingConfig

getValueTypeForRelDataTypeFull

@Nullable
public static ColumnType getValueTypeForRelDataTypeFull(org.apache.calcite.rel.type.RelDataType type)

Convert RelDataType to the most appropriate ValueType

isDoubleType

public static boolean isDoubleType(org.apache.calcite.sql.type.SqlTypeName sqlTypeName)

isLongType

public static boolean isLongType(org.apache.calcite.sql.type.SqlTypeName sqlTypeName)

getStringComparatorForRelDataType

public static StringComparator getStringComparatorForRelDataType(org.apache.calcite.rel.type.RelDataType dataType)

getStringComparatorForValueType

public static StringComparator getStringComparatorForValueType(ColumnType valueType)

createSqlType

public static org.apache.calcite.rel.type.RelDataType createSqlType(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
                                                                    org.apache.calcite.sql.type.SqlTypeName typeName)

Like RelDataTypeFactory.createSqlType, but creates types that align best with how Druid represents them.

createSqlTypeWithNullability

public static org.apache.calcite.rel.type.RelDataType createSqlTypeWithNullability(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
                                                                                   org.apache.calcite.sql.type.SqlTypeName typeName,
                                                                                   boolean nullable)

Like RelDataTypeFactory.createSqlTypeWithNullability, but creates types that align best with how Druid represents them.

createSqlArrayTypeWithNullability

public static org.apache.calcite.rel.type.RelDataType createSqlArrayTypeWithNullability(org.apache.calcite.rel.type.RelDataTypeFactory typeFactory,
                                                                                        org.apache.calcite.sql.type.SqlTypeName elementTypeName,
                                                                                        boolean nullable)

Like RelDataTypeFactory.createSqlTypeWithNullability, but creates types that align best with how Druid represents them.

jodaToCalciteTimestamp

public static long jodaToCalciteTimestamp(org.joda.time.DateTime dateTime,
                                          org.joda.time.DateTimeZone timeZone)

Calcite expects "TIMESTAMP" types to be an instant that has the expected local time fields if printed as UTC.

Parameters:

dateTime - joda timestamp

timeZone - session time zone

Returns:

Calcite style millis

jodaToCalciteDate

public static int jodaToCalciteDate(org.joda.time.DateTime dateTime,
                                    org.joda.time.DateTimeZone timeZone)

Calcite expects "DATE" types to be number of days from the epoch to the UTC date matching the local time fields.

Parameters:

dateTime - joda timestamp

timeZone - session time zone

Returns:

Calcite style date

jodaToCalciteTimestampLiteral

public static org.apache.calcite.rex.RexLiteral jodaToCalciteTimestampLiteral(org.apache.calcite.rex.RexBuilder rexBuilder,
                                                                              org.joda.time.DateTime dateTime,
                                                                              org.joda.time.DateTimeZone sessionTimeZone,
                                                                              int precision)

Creates a Calcite TIMESTAMP literal from a Joda DateTime.

Parameters:

dateTime - joda timestamp

sessionTimeZone - session time zone

Returns:

Calcite style Calendar, appropriate for literals

jodaToCalciteTimeString

public static org.apache.calcite.util.TimeString jodaToCalciteTimeString(org.joda.time.DateTime dateTime,
                                                                         org.joda.time.DateTimeZone timeZone)

Calcite expects TIME literals to be represented by TimeStrings in the local time zone.

Parameters:

dateTime - joda timestamp

timeZone - session time zone

Returns:

Calcite style Calendar, appropriate for literals

jodaToCalciteDateString

public static org.apache.calcite.util.DateString jodaToCalciteDateString(org.joda.time.DateTime dateTime,
                                                                         org.joda.time.DateTimeZone timeZone)

Calcite expects DATE literals to be represented by DateStrings in the local time zone.

Parameters:

dateTime - joda timestamp

timeZone - session time zone

Returns:

Calcite style Calendar, appropriate for literals

calciteDateTimeLiteralToJoda

public static org.joda.time.DateTime calciteDateTimeLiteralToJoda(org.apache.calcite.rex.RexNode literal,
                                                                  org.joda.time.DateTimeZone timeZone)

Translates "literal" (a TIMESTAMP or DATE literal) to milliseconds since the epoch using the provided session time zone.

Parameters:

literal - TIMESTAMP or DATE literal

timeZone - session time zone

Returns:

milliseconds time

calciteTimestampToJoda

public static org.joda.time.DateTime calciteTimestampToJoda(long timestamp,
                                                            org.joda.time.DateTimeZone timeZone)

The inverse of jodaToCalciteTimestamp(DateTime, DateTimeZone).

Parameters:

timestamp - Calcite style timestamp

timeZone - session time zone

Returns:

joda timestamp, with time zone set to the session time zone

calciteDateToJoda

public static org.joda.time.DateTime calciteDateToJoda(int date,
                                                       org.joda.time.DateTimeZone timeZone)

The inverse of jodaToCalciteDate(DateTime, DateTimeZone).

Parameters:

date - Calcite style date

timeZone - session time zone

Returns:

joda timestamp, with time zone set to the session time zone

findUnusedPrefixForDigits

public static String findUnusedPrefixForDigits(String basePrefix,
                                               Iterable<String> strings)

Find a string that is either equal to "basePrefix", or basePrefix prepended by underscores, and where nothing in "strings" starts with prefix plus a digit.

makePrefixedName

public static String makePrefixedName(String prefix,
                                      String suffix)

sqlTypeNameJdbcToJavaClass

public static Class<?> sqlTypeNameJdbcToJavaClass(org.apache.calcite.sql.type.SqlTypeName typeName)