Enum CalciteConnectionProperty

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

    public enum CalciteConnectionProperty
    extends java.lang.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 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.
      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'.
      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.
    • Constructor Summary

      Constructors 
      Modifier Constructor Description
      private CalciteConnectionProperty​(java.lang.String camelName, org.apache.calcite.avatica.ConnectionProperty.Type type, java.lang.Object defaultValue, boolean required)  
      private CalciteConnectionProperty​(java.lang.String camelName, org.apache.calcite.avatica.ConnectionProperty.Type type, java.lang.Object defaultValue, boolean required, java.lang.Class valueClass)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String camelName()  
      java.lang.Object defaultValue()  
      private static java.util.Map<org.apache.calcite.avatica.ConnectionProperty,​java.lang.String> parse2​(java.util.Properties properties, java.util.Map<java.lang.String,​? extends org.apache.calcite.avatica.ConnectionProperty> nameToProps)
      Fixed version of ConnectionConfigImpl.parse(java.util.Properties, java.util.Map<java.lang.String, ? extends org.apache.calcite.avatica.ConnectionProperty>) until we upgrade Avatica.
      boolean required()  
      org.apache.calcite.avatica.ConnectionProperty.Type type()  
      java.lang.Class valueClass()  
      static CalciteConnectionProperty valueOf​(java.lang.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​(java.util.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

      • 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.
      • 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.
      • FUN

        public static final CalciteConnectionProperty FUN
        Collection of built-in functions and operators. Valid values include "standard", "mysql", "oracle", "postgresql" and "spatial", and also comma-separated lists, for example "oracle,spatial".
      • 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.
      • 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_COERCION

        public static final CalciteConnectionProperty TYPE_COERCION
        Whether to make implicit type coercion when type mismatch for validation, default true.
    • Field Detail

      • camelName

        private final java.lang.String camelName
      • type

        private final org.apache.calcite.avatica.ConnectionProperty.Type type
      • defaultValue

        private final java.lang.Object defaultValue
      • required

        private final boolean required
      • valueClass

        private final java.lang.Class valueClass
    • Constructor Detail

      • CalciteConnectionProperty

        private CalciteConnectionProperty​(java.lang.String camelName,
                                          org.apache.calcite.avatica.ConnectionProperty.Type type,
                                          java.lang.Object defaultValue,
                                          boolean required)
      • CalciteConnectionProperty

        private CalciteConnectionProperty​(java.lang.String camelName,
                                          org.apache.calcite.avatica.ConnectionProperty.Type type,
                                          java.lang.Object defaultValue,
                                          boolean required,
                                          java.lang.Class valueClass)
    • 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​(java.lang.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:
        java.lang.IllegalArgumentException - if this enum type has no constant with the specified name
        java.lang.NullPointerException - if the argument is null
      • camelName

        public java.lang.String camelName()
        Specified by:
        camelName in interface org.apache.calcite.avatica.ConnectionProperty
      • defaultValue

        public java.lang.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 java.lang.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​(java.util.Properties properties)
        Specified by:
        wrap in interface org.apache.calcite.avatica.ConnectionProperty
      • parse2

        private static java.util.Map<org.apache.calcite.avatica.ConnectionProperty,​java.lang.String> parse2​(java.util.Properties properties,
                                                                                                                  java.util.Map<java.lang.String,​? extends org.apache.calcite.avatica.ConnectionProperty> nameToProps)
        Fixed version of ConnectionConfigImpl.parse(java.util.Properties, java.util.Map<java.lang.String, ? extends org.apache.calcite.avatica.ConnectionProperty>) until we upgrade Avatica.