org.apache.calcite.config

Enum CalciteConnectionProperty

java.lang.Object

java.lang.Enum<CalciteConnectionProperty>

org.apache.calcite.config.CalciteConnectionProperty

All Implemented Interfaces:

Serializable, Comparable<CalciteConnectionProperty>, ConnectionProperty

public enum CalciteConnectionProperty
extends Enum<CalciteConnectionProperty>
implements ConnectionProperty

Properties that may be specified on the JDBC connect string.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.calcite.avatica.ConnectionProperty

ConnectionProperty.Type

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO_TEMP Whether to store query results in temporary tables.
CASE_SENSITIVE Whether identifiers are matched case-sensitively.
CREATE_MATERIALIZATIONS Whether Calcite should create materializations.
FORCE_DECORRELATE If the planner should try de-correlating as much as it is possible.
LEX Lexical policy.
MATERIALIZATIONS_ENABLED Whether Calcite should use materializations.
MODEL URI of the model.
QUOTED_CASING How identifiers are stored if they are quoted.
QUOTING How identifiers are quoted.
SCHEMA Name of initial schema.
SPARK Specifies whether Spark should be used as the engine for processing that cannot be pushed to the source system.
TIMEZONE Timezone, for example 'gmt-3'.
TYPE_SYSTEM Type system.
UNQUOTED_CASING How identifiers are stored if they are not quoted.

Method Summary

Methods

Modifier and Type	Method and Description
String	camelName()
Object	defaultValue()
boolean	required()
ConnectionProperty.Type	type()
static CalciteConnectionProperty	valueOf(String name) Returns the enum constant of this type with the specified name.
static CalciteConnectionProperty[]	values() Returns an array containing the constants of this enum type, in the order they are declared.
ConnectionConfigImpl.PropEnv	wrap(Properties properties)

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

Methods inherited from interface org.apache.calcite.avatica.ConnectionProperty

name

Enum Constant Detail

AUTO_TEMP

public static final CalciteConnectionProperty AUTO_TEMP

Whether to store query results in temporary tables.

MATERIALIZATIONS_ENABLED

public static final CalciteConnectionProperty MATERIALIZATIONS_ENABLED

Whether Calcite should use materializations.

CREATE_MATERIALIZATIONS

public static final CalciteConnectionProperty CREATE_MATERIALIZATIONS

Whether Calcite should create materializations.

MODEL

public static final CalciteConnectionProperty MODEL

URI of the model.

LEX

public static final CalciteConnectionProperty LEX

Lexical policy.

QUOTING

public static final CalciteConnectionProperty QUOTING

How identifiers are quoted. If not specified, value from LEX is used.

QUOTED_CASING

public static final CalciteConnectionProperty QUOTED_CASING

How identifiers are stored if they are quoted. If not specified, value from LEX is used.

UNQUOTED_CASING

public static final CalciteConnectionProperty UNQUOTED_CASING

How identifiers are stored if they are not quoted. If not specified, value from LEX is used.

CASE_SENSITIVE

public static final CalciteConnectionProperty CASE_SENSITIVE

Whether identifiers are matched case-sensitively. If not specified, value from LEX is used.

SCHEMA

public static final CalciteConnectionProperty SCHEMA

Name of initial schema.

SPARK

public static final CalciteConnectionProperty SPARK

Specifies whether Spark should be used as the engine for processing that cannot be pushed to the source system. If false (the default), Calcite generates code that implements the Enumerable interface.

TIMEZONE

public static final CalciteConnectionProperty TIMEZONE

Timezone, for example 'gmt-3'. Default is the JVM's time zone.

FORCE_DECORRELATE

public static final CalciteConnectionProperty FORCE_DECORRELATE

If the planner should try de-correlating as much as it is possible. If true (the default), Calcite de-correlates the plan.

TYPE_SYSTEM

public static final CalciteConnectionProperty TYPE_SYSTEM

Type system. The name of a class that implements RelDataTypeSystem and has a public default constructor or an INSTANCE constant.

Method Detail

values

public static CalciteConnectionProperty[] 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 (CalciteConnectionProperty c : CalciteConnectionProperty.values())
    System.out.println(c);

Returns:

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

valueOf

public static CalciteConnectionProperty 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

camelName

public String camelName()

Specified by:

camelName in interface ConnectionProperty

defaultValue

public Object defaultValue()

Specified by:

defaultValue in interface ConnectionProperty

type

public ConnectionProperty.Type type()

Specified by:

type in interface ConnectionProperty

required

public boolean required()

Specified by:

required in interface ConnectionProperty

wrap

public ConnectionConfigImpl.PropEnv wrap(Properties properties)

Specified by:

wrap in interface ConnectionProperty