Package org.apache.calcite.util

Interface SaffronProperties

@Deprecated public interface SaffronProperties
Deprecated.
As of release 1.19, replaced by CalciteSystemProperty
Provides an environment for debugging information, et cetera, used by saffron.

It is a singleton, accessed via the INSTANCE object. It is populated from System properties if saffron is invoked via a main() method, from a javax.servlet.ServletContext if saffron is invoked from a servlet, and so forth. If there is a file called "saffron.properties" in the current directory, it is read too.

Every property used in saffron code must have a method in this interface. The method must return a sub-class of Resources.Prop. The javadoc comment must describe the name of the property (for example, "net.sf.saffron.connection.PoolSize") and the default value, if any. Developers, please make sure that this remains so!

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static class 
    SaffronProperties.Helper
    Deprecated.
    Helper class.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final SaffronProperties
    INSTANCE
    Deprecated.
     

  • Method Summary

    Modifier and Type
    Method
    Description
    org.apache.calcite.runtime.Resources.BooleanProp
    allowInfiniteCostConverters()
    Deprecated.
    The boolean property "saffron.opt.allowInfiniteCostConverters" determines whether the optimizer will consider adding converters of infinite cost in order to convert a relational expression from one calling convention to another.
    org.apache.calcite.runtime.Resources.StringProp
    defaultCharset()
    Deprecated.
    The string property "saffron.default.charset" is the name of the default character set.
    org.apache.calcite.runtime.Resources.StringProp
    defaultCollation()
    Deprecated.
    The string property "saffron.default.collation.name" is the name of the default collation.
    org.apache.calcite.runtime.Resources.StringProp
    defaultCollationStrength()
    Deprecated.
    The string property "saffron.default.collation.strength" is the strength of the default collation.
    org.apache.calcite.runtime.Resources.StringProp
    defaultNationalCharset()
    Deprecated.
    The string property "saffron.default.nationalcharset" is the name of the default national character set which is used with the N'string' construct which may or may not be different from the defaultCharset().
    org.apache.calcite.runtime.Resources.IntProp
    metadataHandlerCacheMaximumSize()
    Deprecated.
    The string property "saffron.metadata.handler.cache.maximum.size" is the maximum size of the cache of metadata handlers.

  • Field Details

  • Method Details

    • allowInfiniteCostConverters

      org.apache.calcite.runtime.Resources.BooleanProp allowInfiniteCostConverters()
      Deprecated.
      The boolean property "saffron.opt.allowInfiniteCostConverters" determines whether the optimizer will consider adding converters of infinite cost in order to convert a relational expression from one calling convention to another. The default value is true.

    • defaultCharset

      org.apache.calcite.runtime.Resources.StringProp defaultCharset()
      Deprecated.
      The string property "saffron.default.charset" is the name of the default character set. The default is "ISO-8859-1". It is used in SqlValidator.

    • defaultNationalCharset

      org.apache.calcite.runtime.Resources.StringProp defaultNationalCharset()
      Deprecated.
      The string property "saffron.default.nationalcharset" is the name of the default national character set which is used with the N'string' construct which may or may not be different from the defaultCharset(). The default is "ISO-8859-1". It is used in SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)

    • defaultCollation

      org.apache.calcite.runtime.Resources.StringProp defaultCollation()
      Deprecated.
      The string property "saffron.default.collation.name" is the name of the default collation. The default is "ISO-8859-1$en_US". Used in SqlCollation and SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)

    • defaultCollationStrength

      org.apache.calcite.runtime.Resources.StringProp defaultCollationStrength()
      Deprecated.
      The string property "saffron.default.collation.strength" is the strength of the default collation. The default is "primary". Used in SqlCollation and SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)

    • metadataHandlerCacheMaximumSize

      org.apache.calcite.runtime.Resources.IntProp metadataHandlerCacheMaximumSize()
      Deprecated.
      The string property "saffron.metadata.handler.cache.maximum.size" is the maximum size of the cache of metadata handlers. A typical value is the number of queries being concurrently prepared multiplied by the number of types of metadata.

      If the value is less than 0, there is no limit. The default is 1,000.