org.apache.calcite

Enum DataContext.Variable

java.lang.Object

java.lang.Enum<DataContext.Variable>

org.apache.calcite.DataContext.Variable

All Implemented Interfaces:

Serializable, Comparable<DataContext.Variable>

Enclosing interface:

DataContext

public static enum DataContext.Variable
extends Enum<DataContext.Variable>

Variable that may be asked for in a call to DataContext.get(java.lang.String).

Enum Constant Summary

Enum Constants

Enum Constant and Description
CURRENT_TIMESTAMP The time at which the current statement started executing.
LOCAL_TIMESTAMP The time at which the current statement started executing.
SPARK_CONTEXT The Spark engine.
SQL_ADVISOR Sql advisor that suggests completion hints.
TIME_ZONE Time zone in which the current statement is executing.
UTC_TIMESTAMP

Field Summary

Fields

Modifier and Type	Field and Description
String	camelName
Class	clazz

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	get(DataContext dataContext) Returns the value of this variable in a given data context.
static DataContext.Variable	valueOf(String name) Returns the enum constant of this type with the specified name.
static DataContext.Variable[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

UTC_TIMESTAMP

public static final DataContext.Variable UTC_TIMESTAMP

CURRENT_TIMESTAMP

public static final DataContext.Variable CURRENT_TIMESTAMP

The time at which the current statement started executing. In milliseconds after 1970-01-01 00:00:00, UTC. Required.

LOCAL_TIMESTAMP

public static final DataContext.Variable LOCAL_TIMESTAMP

The time at which the current statement started executing. In milliseconds after 1970-01-01 00:00:00, in the time zone of the current statement. Required.

SPARK_CONTEXT

public static final DataContext.Variable SPARK_CONTEXT

The Spark engine. Available if Spark is on the class path.

SQL_ADVISOR

public static final DataContext.Variable SQL_ADVISOR

Sql advisor that suggests completion hints.

TIME_ZONE

public static final DataContext.Variable TIME_ZONE

Time zone in which the current statement is executing. Required; defaults to the time zone of the JVM if the connection does not specify a time zone.

Field Detail

camelName

public final String camelName

clazz

public final Class clazz

Method Detail

values

public static DataContext.Variable[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DataContext.Variable c : DataContext.Variable.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static DataContext.Variable valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

get

public <T> T get(DataContext dataContext)

Returns the value of this variable in a given data context.