java.lang.Object

java.lang.Enum<CalciteConnectionProperty>

org.apache.calcite.config.CalciteConnectionProperty

All Implemented Interfaces:: Serializable, Comparable<CalciteConnectionProperty>, java.lang.constant.Constable, org.apache.calcite.avatica.ConnectionProperty

public enum CalciteConnectionProperty
extends Enum<CalciteConnectionProperty>
implements org.apache.calcite.avatica.ConnectionProperty

Properties that may be specified on the JDBC connect string.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>

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

Enum Constant Summary

Enum Constants
Enum Constant	Description
`APPROXIMATE_DECIMAL`	Whether approximate results from aggregate functions on DECIMAL types are acceptable.
`APPROXIMATE_DISTINCT_COUNT`	Whether approximate results from `COUNT(DISTINCT ...)` aggregate functions are acceptable.
`APPROXIMATE_TOP_N`	Whether approximate results from "Top N" queries (`ORDER BY aggFun DESC LIMIT n`) are acceptable.
`AUTO_TEMP`	Whether to store query results in temporary tables.
`CASE_SENSITIVE`	Whether identifiers are matched case-sensitively.
`CONFORMANCE`	SQL conformance level.
`CREATE_MATERIALIZATIONS`	Whether Calcite should create materializations.
`DEFAULT_NULL_COLLATION`	How NULL values should be sorted if neither NULLS FIRST nor NULLS LAST are specified.
`DRUID_FETCH`	How many rows the Druid adapter should fetch at a time when executing "select" queries.
`FORCE_DECORRELATE`	If the planner should try de-correlating as much as it is possible.
`FUN`	Collection of built-in functions and operators.
`LENIENT_OPERATOR_LOOKUP`	Whether to make create implicit functions if functions do not exist in the operator table, default false.
`LEX`	Lexical policy.
`LOCALE`	Returns the locale from the connect string.
`MATERIALIZATIONS_ENABLED`	Whether Calcite should use materializations.
`MODEL`	URI of the model.
`NULL_EQUAL_TO_EMPTY`	Whether to treat empty strings as null for Druid Adapter.
`PARSER_FACTORY`	Parser factory.
`QUOTED_CASING`	How identifiers are stored if they are quoted.
`QUOTING`	How identifiers are quoted.
`SCHEMA`	Name of initial schema.
`SCHEMA_FACTORY`	Schema factory.
`SCHEMA_TYPE`	Schema type.
`SPARK`	Specifies whether Spark should be used as the engine for processing that cannot be pushed to the source system.
`TIME_ZONE`	Returns the time zone from the connect string, for example 'gmt-3'.
`TOPDOWN_OPT`	Whether to enable top-down optimization in Volcano planner.
`TYPE_COERCION`	Whether to make implicit type coercion when type mismatch for validation, default true.
`TYPE_SYSTEM`	Type system.
`UNQUOTED_CASING`	How identifiers are stored if they are not quoted.

Field Summary

Fields

Modifier and Type Field Description

static CalciteConnectionProperty TIMEZONE
Deprecated.

Method Summary

Modifier and Type	Method	Description
`String`	`camelName()`
`Object`	`defaultValue()`
`boolean`	`required()`
`org.apache.calcite.avatica.ConnectionProperty.Type`	`type()`
`Class`	`valueClass()`
`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.
`org.apache.calcite.avatica.ConnectionConfigImpl.PropEnv`	`wrap(Properties properties)`

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, 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 Details
- APPROXIMATE_DISTINCT_COUNT
  
  public static final CalciteConnectionProperty APPROXIMATE_DISTINCT_COUNT
  
  Whether approximate results from COUNT(DISTINCT ...) aggregate functions are acceptable.
- APPROXIMATE_TOP_N
  
  public static final CalciteConnectionProperty APPROXIMATE_TOP_N
  
  Whether approximate results from "Top N" queries (ORDER BY aggFun DESC LIMIT n) are acceptable.
- APPROXIMATE_DECIMAL
  
  public static final CalciteConnectionProperty APPROXIMATE_DECIMAL
  
  Whether approximate results from aggregate functions on DECIMAL types are acceptable.
- NULL_EQUAL_TO_EMPTY
  
  public static final CalciteConnectionProperty NULL_EQUAL_TO_EMPTY
  
  Whether to treat empty strings as null for Druid Adapter.
- 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.
- DEFAULT_NULL_COLLATION
  
  public static final CalciteConnectionProperty DEFAULT_NULL_COLLATION
  
  How NULL values should be sorted if neither NULLS FIRST nor NULLS LAST are specified. The default, HIGH, sorts NULL values the same as Oracle.
- DRUID_FETCH
  
  public static final CalciteConnectionProperty DRUID_FETCH
  
  How many rows the Druid adapter should fetch at a time when executing "select" queries.
- MODEL
  
  public static final CalciteConnectionProperty MODEL
  
  URI of the model.
- LEX
  
  public static final CalciteConnectionProperty LEX
  
  Lexical policy.
- FUN
  
  public static final CalciteConnectionProperty FUN
  
  Collection of built-in functions and operators. Valid values include "standard", "bigquery", "mysql", "oracle", "postgresql" and "spatial", and also comma-separated lists, for example "oracle,spatial".
- 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.
- PARSER_FACTORY
  
  public static final CalciteConnectionProperty PARSER_FACTORY
  
  Parser factory.
  The name of a class that implements SqlParserImplFactory.
- SCHEMA
  
  public static final CalciteConnectionProperty SCHEMA
  
  Name of initial schema.
- SCHEMA_FACTORY
  
  public static final CalciteConnectionProperty SCHEMA_FACTORY
  
  Schema factory.
  The name of a class that implements SchemaFactory.
  Ignored if MODEL is specified.
- SCHEMA_TYPE
  
  public static final CalciteConnectionProperty SCHEMA_TYPE
  
  Schema type.
  Value may be null, "MAP", "JDBC", or "CUSTOM" (implicit if SCHEMA_FACTORY is specified).
  Ignored if MODEL is specified.
- 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.
- TIME_ZONE
  
  public static final CalciteConnectionProperty TIME_ZONE
  
  Returns the time zone from the connect string, for example 'gmt-3'. If the time zone is not set then the JVM time zone is returned. Never null.
- LOCALE
  
  public static final CalciteConnectionProperty LOCALE
  
  Returns the locale from the connect string. If the locale is not set, returns the root locale. Never null. Examples of valid locales: 'en', 'en_US', 'de_DE', '_GB', 'en_US_WIN', 'de__POSIX', 'fr__MAC', ''.
- 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.
- CONFORMANCE
  
  public static final CalciteConnectionProperty CONFORMANCE
  
  SQL conformance level.
- TYPE_COERCION
  
  public static final CalciteConnectionProperty TYPE_COERCION
  
  Whether to make implicit type coercion when type mismatch for validation, default true.
- LENIENT_OPERATOR_LOOKUP
  
  public static final CalciteConnectionProperty LENIENT_OPERATOR_LOOKUP
  
  Whether to make create implicit functions if functions do not exist in the operator table, default false.
- TOPDOWN_OPT
  
  public static final CalciteConnectionProperty TOPDOWN_OPT
  
  Whether to enable top-down optimization in Volcano planner.
Field Details
- TIMEZONE
  
  @Deprecated public static final CalciteConnectionProperty TIMEZONE
  
  Deprecated.
  
  Deprecated; use TIME_ZONE.
Method Details
- values
  
  public static CalciteConnectionProperty[] values()
  
  Returns an array containing the constants of this enum type, in the order they are declared.
  
  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 org.apache.calcite.avatica.ConnectionProperty
- defaultValue
  
  public Object defaultValue()
  
  Specified by:
  
  defaultValue in interface org.apache.calcite.avatica.ConnectionProperty
- type
  
  public org.apache.calcite.avatica.ConnectionProperty.Type type()
  
  Specified by:
  
  type in interface org.apache.calcite.avatica.ConnectionProperty
- valueClass
  
  public Class valueClass()
  
  Specified by:
  
  valueClass in interface org.apache.calcite.avatica.ConnectionProperty
- required
  
  public boolean required()
  
  Specified by:
  
  required in interface org.apache.calcite.avatica.ConnectionProperty
- wrap
  
  public org.apache.calcite.avatica.ConnectionConfigImpl.PropEnv wrap(Properties properties)
  
  Specified by:
  
  wrap in interface org.apache.calcite.avatica.ConnectionProperty

Enum CalciteConnectionProperty

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

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

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

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

Enum Constant Details

Field Details

Method Details