| <!DOCTYPE HTML> |
| <html lang="en"> |
| <head> |
| <!-- Generated by javadoc (17) --> |
| <title>SaffronProperties (Apache Calcite API)</title> |
| <meta name="viewport" content="width=device-width, initial-scale=1"> |
| <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> |
| <meta name="description" content="declaration: package: org.apache.calcite.util, interface: SaffronProperties"> |
| <meta name="generator" content="javadoc/ClassWriterImpl"> |
| <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../script-dir/jquery-ui.min.css" title="Style"> |
| <link rel="stylesheet" type="text/css" href="../../../../jquery-ui.overrides.css" title="Style"> |
| <script type="text/javascript" src="../../../../script.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-3.5.1.min.js"></script> |
| <script type="text/javascript" src="../../../../script-dir/jquery-ui.min.js"></script> |
| </head> |
| <body class="class-declaration-page"> |
| <script type="text/javascript">var evenRowColor = "even-row-color"; |
| var oddRowColor = "odd-row-color"; |
| var tableTab = "table-tab"; |
| var activeTableTab = "active-table-tab"; |
| var pathtoroot = "../../../../"; |
| loadScripts(document, 'script');</script> |
| <noscript> |
| <div>JavaScript is disabled on your browser.</div> |
| </noscript> |
| <div class="flex-box"> |
| <header role="banner" class="flex-header"> |
| <nav role="navigation"> |
| <!-- ========= START OF TOP NAVBAR ======= --> |
| <div class="top-nav" id="navbar-top"> |
| <div class="skip-nav"><a href="#skip-navbar-top" title="Skip navigation links">Skip navigation links</a></div> |
| <div class="about-language"><b>Apache Calcite</b></div> |
| <ul id="navbar-top-firstrow" class="nav-list" title="Navigation"> |
| <li><a href="../../../../index.html">Overview</a></li> |
| <li><a href="package-summary.html">Package</a></li> |
| <li class="nav-bar-cell1-rev">Class</li> |
| <li><a href="package-tree.html">Tree</a></li> |
| <li><a href="../../../../deprecated-list.html">Deprecated</a></li> |
| <li><a href="../../../../index-all.html">Index</a></li> |
| <li><a href="../../../../help-doc.html#class">Help</a></li> |
| </ul> |
| </div> |
| <div class="sub-nav"> |
| <div> |
| <ul class="sub-nav-list"> |
| <li>Summary: </li> |
| <li><a href="#nested-class-summary">Nested</a> | </li> |
| <li><a href="#field-summary">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-summary">Method</a></li> |
| </ul> |
| <ul class="sub-nav-list"> |
| <li>Detail: </li> |
| <li><a href="#field-detail">Field</a> | </li> |
| <li>Constr | </li> |
| <li><a href="#method-detail">Method</a></li> |
| </ul> |
| </div> |
| <div class="nav-list-search"><label for="search-input">SEARCH:</label> |
| <input type="text" id="search-input" value="search" disabled="disabled"> |
| <input type="reset" id="reset-button" value="reset" disabled="disabled"> |
| </div> |
| </div> |
| <!-- ========= END OF TOP NAVBAR ========= --> |
| <span class="skip-nav" id="skip-navbar-top"></span></nav> |
| </header> |
| <div class="flex-content"> |
| <main role="main"> |
| <!-- ======== START OF CLASS DATA ======== --> |
| <div class="header"> |
| <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.calcite.util</a></div> |
| <h1 title="Interface SaffronProperties" class="title">Interface SaffronProperties</h1> |
| </div> |
| <section class="class-description" id="class-description"> |
| <hr> |
| <div class="type-signature"><span class="annotations"><a href="https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/lang/Deprecated.html" title="class or interface in java.lang" class="external-link">@Deprecated</a> |
| </span><span class="modifiers">public interface </span><span class="element-name type-name-label">SaffronProperties</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span> |
| <div class="deprecation-comment">As of release 1.19, |
| replaced by <a href="../config/CalciteSystemProperty.html" title="class in org.apache.calcite.config"><code>CalciteSystemProperty</code></a></div> |
| </div> |
| <div class="block">Provides an environment for debugging information, et cetera, used by |
| saffron. |
| |
| <p>It is a singleton, accessed via the <a href="#INSTANCE"><code>INSTANCE</code></a> object. It is |
| populated from System properties if saffron is invoked via a <code> |
| main()</code> method, from a <code>javax.servlet.ServletContext</code> if |
| saffron is invoked from a servlet, and so forth. If there is a file called |
| <code>"saffron.properties"</code> in the current directory, it is read too. |
| |
| <p>Every property used in saffron code must have a method in this interface. |
| The method must return a sub-class of |
| <code>Resources.Prop</code>. The javadoc |
| comment must describe the name of the property (for example, |
| "net.sf.saffron.connection.PoolSize") and the default value, if any. <em> |
| Developers, please make sure that this remains so!</em></div> |
| </section> |
| <section class="summary"> |
| <ul class="summary-list"> |
| <!-- ======== NESTED CLASS SUMMARY ======== --> |
| <li> |
| <section class="nested-class-summary" id="nested-class-summary"> |
| <h2>Nested Class Summary</h2> |
| <div class="caption"><span>Nested Classes</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Interface</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static class </code></div> |
| <div class="col-second even-row-color"><code><a href="SaffronProperties.Helper.html" class="type-name-link" title="class in org.apache.calcite.util">SaffronProperties.Helper</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">Helper class.</div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- =========== FIELD SUMMARY =========== --> |
| <li> |
| <section class="field-summary" id="field-summary"> |
| <h2>Field Summary</h2> |
| <div class="caption"><span>Fields</span></div> |
| <div class="summary-table three-column-summary"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Field</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color"><code>static final <a href="SaffronProperties.html" title="interface in org.apache.calcite.util">SaffronProperties</a></code></div> |
| <div class="col-second even-row-color"><code><a href="#INSTANCE" class="member-name-link">INSTANCE</a></code></div> |
| <div class="col-last even-row-color"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| </div> |
| </div> |
| </section> |
| </li> |
| <!-- ========== METHOD SUMMARY =========== --> |
| <li> |
| <section class="method-summary" id="method-summary"> |
| <h2>Method Summary</h2> |
| <div id="method-summary-table"> |
| <div class="table-tabs" role="tablist" aria-orientation="horizontal"><button id="method-summary-table-tab0" role="tab" aria-selected="true" aria-controls="method-summary-table.tabpanel" tabindex="0" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table', 3)" class="active-table-tab">All Methods</button><button id="method-summary-table-tab2" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab2', 3)" class="table-tab">Instance Methods</button><button id="method-summary-table-tab3" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab3', 3)" class="table-tab">Abstract Methods</button><button id="method-summary-table-tab6" role="tab" aria-selected="false" aria-controls="method-summary-table.tabpanel" tabindex="-1" onkeydown="switchTab(event)" onclick="show('method-summary-table', 'method-summary-table-tab6', 3)" class="table-tab">Deprecated Methods</button></div> |
| <div id="method-summary-table.tabpanel" role="tabpanel"> |
| <div class="summary-table three-column-summary" aria-labelledby="method-summary-table-tab0"> |
| <div class="table-header col-first">Modifier and Type</div> |
| <div class="table-header col-second">Method</div> |
| <div class="table-header col-last">Description</div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>org.apache.calcite.runtime.Resources.BooleanProp</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#allowInfiniteCostConverters()" class="member-name-link">allowInfiniteCostConverters</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>org.apache.calcite.runtime.Resources.StringProp</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#defaultCharset()" class="member-name-link">defaultCharset</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.default.charset" is the name of the default |
| character set.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>org.apache.calcite.runtime.Resources.StringProp</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#defaultCollation()" class="member-name-link">defaultCollation</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.default.collation.name" is the name of the |
| default collation.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>org.apache.calcite.runtime.Resources.StringProp</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#defaultCollationStrength()" class="member-name-link">defaultCollationStrength</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.default.collation.strength" is the strength |
| of the default collation.</div> |
| </div> |
| <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>org.apache.calcite.runtime.Resources.StringProp</code></div> |
| <div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#defaultNationalCharset()" class="member-name-link">defaultNationalCharset</a>()</code></div> |
| <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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 <a href="#defaultCharset()"><code>defaultCharset()</code></a>.</div> |
| </div> |
| <div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code>org.apache.calcite.runtime.Resources.IntProp</code></div> |
| <div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"><code><a href="#metadataHandlerCacheMaximumSize()" class="member-name-link">metadataHandlerCacheMaximumSize</a>()</code></div> |
| <div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3 method-summary-table-tab6"> |
| <div class="block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.metadata.handler.cache.maximum.size" is the |
| maximum size of the cache of metadata handlers.</div> |
| </div> |
| </div> |
| </div> |
| </div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <section class="details"> |
| <ul class="details-list"> |
| <!-- ============ FIELD DETAIL =========== --> |
| <li> |
| <section class="field-details" id="field-detail"> |
| <h2>Field Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="INSTANCE"> |
| <h3>INSTANCE</h3> |
| <div class="member-signature"><span class="modifiers">static final</span> <span class="return-type"><a href="SaffronProperties.html" title="interface in org.apache.calcite.util">SaffronProperties</a></span> <span class="element-name">INSTANCE</span></div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| <!-- ============ METHOD DETAIL ========== --> |
| <li> |
| <section class="method-details" id="method-detail"> |
| <h2>Method Details</h2> |
| <ul class="member-list"> |
| <li> |
| <section class="detail" id="allowInfiniteCostConverters()"> |
| <h3>allowInfiniteCostConverters</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.runtime.Resources.BooleanProp</span> <span class="element-name">allowInfiniteCostConverters</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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 <code>true</code>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultCharset()"> |
| <h3>defaultCharset</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.runtime.Resources.StringProp</span> <span class="element-name">defaultCharset</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.default.charset" is the name of the default |
| character set. The default is "ISO-8859-1". It is used in |
| <a href="../sql/validate/SqlValidator.html" title="interface in org.apache.calcite.sql.validate"><code>SqlValidator</code></a>.</div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultNationalCharset()"> |
| <h3>defaultNationalCharset</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.runtime.Resources.StringProp</span> <span class="element-name">defaultNationalCharset</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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 <a href="#defaultCharset()"><code>defaultCharset()</code></a>. The |
| default is "ISO-8859-1". It is used in |
| <a href="../sql/SqlLiteral.html#%3Cinit%3E(java.lang.Object,org.apache.calcite.sql.type.SqlTypeName,org.apache.calcite.sql.parser.SqlParserPos)"><code>SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultCollation()"> |
| <h3>defaultCollation</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.runtime.Resources.StringProp</span> <span class="element-name">defaultCollation</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.default.collation.name" is the name of the |
| default collation. The default is "ISO-8859-1$en_US". Used in |
| <a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql"><code>SqlCollation</code></a> and |
| <a href="../sql/SqlLiteral.html#%3Cinit%3E(java.lang.Object,org.apache.calcite.sql.type.SqlTypeName,org.apache.calcite.sql.parser.SqlParserPos)"><code>SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="defaultCollationStrength()"> |
| <h3>defaultCollationStrength</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.runtime.Resources.StringProp</span> <span class="element-name">defaultCollationStrength</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">The string property "saffron.default.collation.strength" is the strength |
| of the default collation. The default is "primary". Used in |
| <a href="../sql/SqlCollation.html" title="class in org.apache.calcite.sql"><code>SqlCollation</code></a> and |
| <a href="../sql/SqlLiteral.html#%3Cinit%3E(java.lang.Object,org.apache.calcite.sql.type.SqlTypeName,org.apache.calcite.sql.parser.SqlParserPos)"><code>SqlLiteral(java.lang.Object, org.apache.calcite.sql.type.SqlTypeName, org.apache.calcite.sql.parser.SqlParserPos)</code></a></div> |
| </section> |
| </li> |
| <li> |
| <section class="detail" id="metadataHandlerCacheMaximumSize()"> |
| <h3>metadataHandlerCacheMaximumSize</h3> |
| <div class="member-signature"><span class="return-type">org.apache.calcite.runtime.Resources.IntProp</span> <span class="element-name">metadataHandlerCacheMaximumSize</span>()</div> |
| <div class="deprecation-block"><span class="deprecated-label">Deprecated.</span></div> |
| <div class="block">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. |
| |
| <p>If the value is less than 0, there is no limit. The default is 1,000.</div> |
| </section> |
| </li> |
| </ul> |
| </section> |
| </li> |
| </ul> |
| </section> |
| <!-- ========= END OF CLASS DATA ========= --> |
| </main> |
| <footer role="contentinfo"> |
| <hr> |
| <p class="legal-copy"><small>Copyright © 2012-2023 Apache Software Foundation. All Rights Reserved.</small></p> |
| </footer> |
| </div> |
| </div> |
| </body> |
| </html> |
