Package org.apache.calcite.avatica
Interface ConnectionProperty
-
- All Known Implementing Classes:
AvaticaRemoteConnectionProperty,BuiltInConnectionProperty
public interface ConnectionPropertyDefinition of a property that may be specified on the JDBC connect string.BuiltInConnectionPropertyenumerates built-in properties, but there may be others; the list is not closed.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classConnectionProperty.TypeData type of property.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.StringcamelName()The name of this property in camel-case.java.lang.ObjectdefaultValue()Returns the default value of this property.java.lang.Stringname()The name of this property.booleanrequired()Whether the property is mandatory.ConnectionProperty.Typetype()Returns the data type of this property.java.lang.ClassvalueClass()Class of values that this property can take.ConnectionConfigImpl.PropEnvwrap(java.util.Properties properties)Wraps this property with a properties object from which its value can be obtained when needed.
-
-
-
Method Detail
-
name
java.lang.String name()
The name of this property. (E.g. "MATERIALIZATIONS_ENABLED".)
-
camelName
java.lang.String camelName()
The name of this property in camel-case. (E.g. "materializationsEnabled".)
-
defaultValue
java.lang.Object defaultValue()
Returns the default value of this property. The type must match its data type.
-
type
ConnectionProperty.Type type()
Returns the data type of this property.
-
wrap
ConnectionConfigImpl.PropEnv wrap(java.util.Properties properties)
Wraps this property with a properties object from which its value can be obtained when needed.
-
required
boolean required()
Whether the property is mandatory.
-
valueClass
java.lang.Class valueClass()
Class of values that this property can take. Most useful forConnectionProperty.Type.ENUMproperties.
-
-