Package org.apache.calcite.config

Interface CalciteConnectionConfig

All Superinterfaces:

org.apache.calcite.avatica.ConnectionConfig

All Known Implementing Classes:

CalciteConnectionConfigImpl

public interface CalciteConnectionConfig
extends org.apache.calcite.avatica.ConnectionConfig

Interface for reading connection properties within Calcite code. There is a method for every property. At some point there will be similar config classes for system and statement properties.

Field Summary

Fields

Modifier and Type	Field	Description
static final CalciteConnectionConfigImpl	DEFAULT	Default configuration.

Method Summary

Modifier and Type	Method	Description
boolean	approximateDecimal()	Returns the value of CalciteConnectionProperty.APPROXIMATE_DECIMAL.
boolean	approximateDistinctCount()	Returns the value of CalciteConnectionProperty.APPROXIMATE_DISTINCT_COUNT.
boolean	approximateTopN()	Returns the value of CalciteConnectionProperty.APPROXIMATE_TOP_N.
boolean	autoTemp()	Returns the value of CalciteConnectionProperty.AUTO_TEMP.
boolean	caseSensitive()	Returns the value of CalciteConnectionProperty.CASE_SENSITIVE.
SqlConformance	conformance()	Returns the value of CalciteConnectionProperty.CONFORMANCE.
boolean	createMaterializations()	Returns the value of CalciteConnectionProperty.CREATE_MATERIALIZATIONS.
NullCollation	defaultNullCollation()	Returns the value of CalciteConnectionProperty.DEFAULT_NULL_COLLATION.
boolean	forceDecorrelate()	Returns the value of CalciteConnectionProperty.FORCE_DECORRELATE.
<T> @PolyNull T	fun(Class<T> operatorTableClass, @PolyNull T defaultOperatorTable)	Returns the value of CalciteConnectionProperty.FUN, or a default operator table if not set.
boolean	lenientOperatorLookup()	Returns the value of CalciteConnectionProperty.LENIENT_OPERATOR_LOOKUP.
Lex	lex()	Returns the value of CalciteConnectionProperty.LEX.
String	locale()	Returns the value of CalciteConnectionProperty.LOCALE.
boolean	materializationsEnabled()	Returns the value of CalciteConnectionProperty.MATERIALIZATIONS_ENABLED.
<T> @PolyNull T	metaColumnFactory(Class<T> metaColumnFactoryClass, @PolyNull T defaultMetaColumnFactory)	Returns the value of CalciteConnectionProperty.META_COLUMN_FACTORY, or a default meta column factory if not set.
<T> @PolyNull T	metaTableFactory(Class<T> metaTableFactoryClass, @PolyNull T defaultMetaTableFactory)	Returns the value of CalciteConnectionProperty.META_TABLE_FACTORY, or a default meta table factory if not set.
@Nullable String	model()	Returns the value of CalciteConnectionProperty.MODEL.
boolean	nullEqualToEmpty()	Returns the value of CalciteConnectionProperty.NULL_EQUAL_TO_EMPTY.
<T> @PolyNull T	parserFactory(Class<T> parserFactoryClass, @PolyNull T defaultParserFactory)	Returns the value of CalciteConnectionProperty.PARSER_FACTORY, or a default parser if not set.
org.apache.calcite.avatica.util.Casing	quotedCasing()	Returns the value of CalciteConnectionProperty.QUOTED_CASING.
org.apache.calcite.avatica.util.Quoting	quoting()	Returns the value of CalciteConnectionProperty.QUOTING.
<T> @PolyNull T	schemaFactory(Class<T> schemaFactoryClass, @PolyNull T defaultSchemaFactory)	Returns the value of CalciteConnectionProperty.SCHEMA_FACTORY, or a default schema factory if not set.
JsonSchema.Type	schemaType()	Returns the value of CalciteConnectionProperty.SCHEMA_TYPE.
boolean	spark()	Returns the value of CalciteConnectionProperty.SPARK.
String	timeZone()	Returns the value of CalciteConnectionProperty.TIME_ZONE.
boolean	topDownOpt()	Returns the value of CalciteConnectionProperty.TOPDOWN_OPT.
boolean	typeCoercion()	Returns the value of CalciteConnectionProperty.TYPE_COERCION.
<T> @PolyNull T	typeSystem(Class<T> typeSystemClass, @PolyNull T defaultTypeSystem)	Returns the value of CalciteConnectionProperty.TYPE_SYSTEM, or a default type system if not set.
org.apache.calcite.avatica.util.Casing	unquotedCasing()	Returns the value of CalciteConnectionProperty.UNQUOTED_CASING.

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

authentication, avaticaPassword, avaticaUser, factory, fetchSize, getHttpConnectionTimeout, getHttpResponseTimeout, getLBConnectionFailoverRetries, getLBConnectionFailoverSleepTime, getLBStrategy, getLbURLs, hostnameVerification, httpClientClass, httpClientFactory, kerberosKeytab, kerberosPrincipal, keyPassword, keystore, keystorePassword, keystoreType, schema, serialization, transparentReconnectionEnabled, truststore, truststorePassword, url, useClientSideLb

Field Details

DEFAULT

static final CalciteConnectionConfigImpl DEFAULT

Default configuration.

Method Details

approximateDistinctCount

boolean approximateDistinctCount()

Returns the value of CalciteConnectionProperty.APPROXIMATE_DISTINCT_COUNT.

approximateTopN

boolean approximateTopN()

Returns the value of CalciteConnectionProperty.APPROXIMATE_TOP_N.

approximateDecimal

boolean approximateDecimal()

Returns the value of CalciteConnectionProperty.APPROXIMATE_DECIMAL.

nullEqualToEmpty

boolean nullEqualToEmpty()

Returns the value of CalciteConnectionProperty.NULL_EQUAL_TO_EMPTY.

autoTemp

boolean autoTemp()

Returns the value of CalciteConnectionProperty.AUTO_TEMP.

materializationsEnabled

boolean materializationsEnabled()

Returns the value of CalciteConnectionProperty.MATERIALIZATIONS_ENABLED.

createMaterializations

boolean createMaterializations()

Returns the value of CalciteConnectionProperty.CREATE_MATERIALIZATIONS.

defaultNullCollation

NullCollation defaultNullCollation()

Returns the value of CalciteConnectionProperty.DEFAULT_NULL_COLLATION.

fun

<T> @PolyNull T fun(Class<T> operatorTableClass,
 @PolyNull T defaultOperatorTable)

Returns the value of CalciteConnectionProperty.FUN, or a default operator table if not set. If defaultOperatorTable is not null, the result is never null.

model

@Nullable String model()

Returns the value of CalciteConnectionProperty.MODEL.

lex

Lex lex()

Returns the value of CalciteConnectionProperty.LEX.

quoting

org.apache.calcite.avatica.util.Quoting quoting()

Returns the value of CalciteConnectionProperty.QUOTING.

unquotedCasing

org.apache.calcite.avatica.util.Casing unquotedCasing()

Returns the value of CalciteConnectionProperty.UNQUOTED_CASING.

quotedCasing

org.apache.calcite.avatica.util.Casing quotedCasing()

Returns the value of CalciteConnectionProperty.QUOTED_CASING.

caseSensitive

boolean caseSensitive()

Returns the value of CalciteConnectionProperty.CASE_SENSITIVE.

parserFactory

<T> @PolyNull T parserFactory(Class<T> parserFactoryClass,
 @PolyNull T defaultParserFactory)

Returns the value of CalciteConnectionProperty.PARSER_FACTORY, or a default parser if not set. If defaultParserFactory is not null, the result is never null.

schemaFactory

<T> @PolyNull T schemaFactory(Class<T> schemaFactoryClass,
 @PolyNull T defaultSchemaFactory)

Returns the value of CalciteConnectionProperty.SCHEMA_FACTORY, or a default schema factory if not set. If defaultSchemaFactory is not null, the result is never null.

schemaType

JsonSchema.Type schemaType()

Returns the value of CalciteConnectionProperty.SCHEMA_TYPE.

spark

boolean spark()

Returns the value of CalciteConnectionProperty.SPARK.

forceDecorrelate

boolean forceDecorrelate()

Returns the value of CalciteConnectionProperty.FORCE_DECORRELATE.

typeSystem

<T> @PolyNull T typeSystem(Class<T> typeSystemClass,
 @PolyNull T defaultTypeSystem)

Returns the value of CalciteConnectionProperty.TYPE_SYSTEM, or a default type system if not set. If defaultTypeSystem is not null, the result is never null.

conformance

SqlConformance conformance()

Returns the value of CalciteConnectionProperty.CONFORMANCE.

timeZone

String timeZone()

Returns the value of CalciteConnectionProperty.TIME_ZONE.

Specified by:

timeZone in interface org.apache.calcite.avatica.ConnectionConfig

locale

String locale()

Returns the value of CalciteConnectionProperty.LOCALE.

typeCoercion

boolean typeCoercion()

Returns the value of CalciteConnectionProperty.TYPE_COERCION.

lenientOperatorLookup

boolean lenientOperatorLookup()

Returns the value of CalciteConnectionProperty.LENIENT_OPERATOR_LOOKUP.

topDownOpt

boolean topDownOpt()

Returns the value of CalciteConnectionProperty.TOPDOWN_OPT.

metaTableFactory

<T> @PolyNull T metaTableFactory(Class<T> metaTableFactoryClass,
 @PolyNull T defaultMetaTableFactory)

Returns the value of CalciteConnectionProperty.META_TABLE_FACTORY, or a default meta table factory if not set. If defaultMetaTableFactory is not null, the result is never null.

metaColumnFactory

<T> @PolyNull T metaColumnFactory(Class<T> metaColumnFactoryClass,
 @PolyNull T defaultMetaColumnFactory)

Returns the value of CalciteConnectionProperty.META_COLUMN_FACTORY, or a default meta column factory if not set. If defaultMetaColumnFactory is not null, the result is never null.