docs/5.0/cayenne-guide/appendix-a-configuration-properties/index.html - cayenne-website - Git at Google

 <!DOCTYPE html>
 <html lang="en">
     <head>
         <meta charset="utf-8">
         <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3">
         <link rel="apple-touch-icon" sizes="180x180" href="/img/favicon/apple-touch-icon-04cb17e028.png">
         <link rel="icon" type="image/png" sizes="32x32" href="/img/favicon/favicon-32x32-12431ee8eb.png">
         <link rel="icon" type="image/png" sizes="16x16" href="/img/favicon/favicon-16x16-4f316e4d55.png">
         <link rel="manifest" href="/img/favicon/manifest-65e6aaa49e.json">
         <link rel="mask-icon" href="/img/favicon/safari-pinned-tab-558c1991b1.svg" color="#dc5656">
         <link rel="shortcut icon" href="/img/favicon/favicon-6cef91375b.ico">
         <meta name="msapplication-TileColor" content="#ffffff">
         <meta name="msapplication-TileImage" content="/img/favicon/mstile-144x144-34e7696278.png">
         <meta name="msapplication-config" content="/img/favicon/browserconfig-82ff158058.xml">
         <meta name="theme-color" content="#ffffff">
         <link rel="stylesheet" href="https://cayenne.apache.org/css/styles-9ee2e6e330.css"/>
         <script src="https://cayenne.apache.org/js/bundle-c0e6356367.js"></script>
         <title>Cayenne Guide 5.0 · Appendix A. Configuration Properties &middot; Apache Cayenne</title>
     </head>
     <body  class="cd-head">
 <header class="page-header">
     <nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation">
       <ul class="breadcrumb breadcrumb-sm breadcrumb-dark  container  mb-0">
         <li class="breadcrumb-item dropdown">
           <a class="dropdown-toggle  text-nowrap  pr-1" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
             <img class="mw-15px  mr-1" src="/img/feather-641aa69d09.svg" />Apache Software Foundation</a>
           <div class="dropdown-menu rounded-0" aria-labelledby="navbarDropdown">
             <a class="dropdown-item" href="https://www.apache.org">Apache Homepage</a>
             <a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
             <a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
             <a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
             <a class="dropdown-item" href="https://www.apache.org/security/">Security</a>
             <a class="dropdown-item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a>
             <a class="ml-1 mt-1 acevent" data-format="wide" data-mode="dark" data-width="120"></a>
           </div>
         </li>
       </ul>
     </nav>
     <nav class="navbar navbar-expand-lg navbar-dark bg-primary">
       <div class="container">
         <a class="navbar-brand" href="https://cayenne.apache.org/">
            <img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" />
         </a>
         <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation">
           <span class="navbar-toggler-icon"></span>
         </button>

         <div class="collapse navbar-collapse" id="mainMenu">
           <ul class="navbar-nav  mt-3 mt-lg-0 mr-auto">

             <li class="nav-item">
               <a class="nav-link" href="/download/">DOWNLOAD</a>
             </li>

             <li class="nav-item">
               <a class="nav-link" href="/docs/4.2/getting-started-guide/">DOCUMENTATION</a>
             </li>

             <li class="nav-item">
               <a class="nav-link" href="/about/support/">SUPPORT</a>
             </li>

           </ul>
           <ul class="navbar-nav  flex-row justify-content-center  mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu">
             <li class="nav-item  d-flex">
               <a class="nav-link  d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne">
                 <img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" />
               </a>
             </li>
             <li class="nav-item  d-flex">
               <a class="nav-link  d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne">
                 <img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" />
               </a>
             </li>
           </ul>
         </div>
       </div>
     </nav>
 </header>


 <main>
     <div class="cd-top-sidebar  bb">
         <div class="container">
             <div class="row no-gutters">

                 <div class="col-12 col-lg-4 col-xl-3  br  cd-sidebar1">
                     <ul class="nav" role="tablist">
                         <li class="nav-item dropdown mw-100">
                             <a class="nav-link dropdown-toggle text-truncate" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">
                                 Cayenne Version 5.0
                             </a>
                             <div class="dropdown-menu">
                                 <a class="dropdown-item" href="/docs/5.0/cayenne-guide/">Version 5.0 (Alpha)</a><a class="dropdown-item" href="/docs/4.2/getting-started-guide/">Version 4.2 (Stable)</a><a class="dropdown-item" href="/docs/4.1/getting-started-guide/">Version 4.1 (Stable)</a><a class="dropdown-item" href="/docs/4.0/getting-started-guide/">Version 4.0 (Aging)</a><a class="dropdown-item" href="/docs/3.1/getting-started-guide/">Version 3.1 (Legacy)</a>
                             </div>
                         </li>
                     </ul>
                 </div>
                 <div class="col-12 col-lg-8 col-xl-9">  </div>
             </div>
         </div>
     </div>
     <div class="container">
         <div class="row no-gutters  ">
             <div class="col-12 col-lg-4 col-xl-3  br  py-2  bg-gray-100  cd-sidebar">
                 <div class="tab-content" id="cd-docs-nav">

                     <div class="cd-toc-item">

                         <span class="cd-toc-link active">Cayenne Guide 5.0</span><div id="toc" class="toc toc-side">
  <div id="toctitle">
   Table of Contents
  </div>
  <ul class="sectlevel1 nav">
   <li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne" class="nav-link" id="object-relational-mapping-with-cayenne">1. Object Relational Mapping with Cayenne</a>
    <ul class="sectlevel2 nav">
     <li><a href="/docs/5.0/cayenne-guide/setup" class="nav-link" id="setup">1.1. Setup</a></li>
     <li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure" class="nav-link" id="cayenne-mapping-structure">1.2. Cayenne Mapping Structure</a></li>
     <li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" class="nav-link" id="cayenne-modeler">1.3. CayenneModeler Application</a></li>
    </ul></li>
   <li><a href="/docs/5.0/cayenne-guide/cayenne-framework" class="nav-link" id="cayenne-framework">2. Cayenne Framework</a>
    <ul class="sectlevel2 nav">
     <li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project" class="nav-link" id="including-cayenne-in-project">2.1. Including Cayenne in a Project</a></li>
     <li><a href="/docs/5.0/cayenne-guide/starting-cayenne" class="nav-link" id="starting-cayenne">2.2. Starting Cayenne</a></li>
     <li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext" class="nav-link" id="persistent-objects-objectcontext">2.3. Persistent Objects and ObjectContext</a></li>
     <li><a href="/docs/5.0/cayenne-guide/expressions" class="nav-link" id="expressions">2.4. Expressions</a></li>
     <li><a href="/docs/5.0/cayenne-guide/orderings" class="nav-link" id="orderings">2.5. Orderings</a></li>
     <li><a href="/docs/5.0/cayenne-guide/queries" class="nav-link" id="queries">2.6. Queries</a></li>
     <li><a href="/docs/5.0/cayenne-guide/lifecycle-events" class="nav-link" id="lifecycle-events">2.7. Lifecycle Events</a></li>
     <li><a href="/docs/5.0/cayenne-guide/performance-tuning" class="nav-link" id="performance-tuning">2.8. Performance Tuning</a></li>
     <li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime" class="nav-link" id="customizing-cayenne-runtime">2.9. Customizing Cayenne Runtime</a></li>
    </ul></li>
   <li><a href="/docs/5.0/cayenne-guide/db-first-flow" class="nav-link" id="db-first-flow">3. DB-First Flow</a>
    <ul class="sectlevel2 nav">
     <li><a href="/docs/5.0/cayenne-guide/re-introduction" class="nav-link" id="re-introduction">3.1. Introduction</a></li>
     <li><a href="/docs/5.0/cayenne-guide/re-filtering" class="nav-link" id="re-filtering">3.2. Filtering</a></li>
     <li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control" class="nav-link" id="re-relationships-loading-control">3.3. Other Settings</a></li>
     <li><a href="/docs/5.0/cayenne-guide/re-modeler" class="nav-link" id="re-modeler">3.4. Reverse Engineering in Cayenne Modeler</a></li>
    </ul></li>
   <li><a href="/docs/5.0/cayenne-guide/additional-modules" class="nav-link" id="additional-modules">4. Additional Modules</a>
    <ul class="sectlevel2 nav">
     <li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation" class="nav-link" id="ext-cache-invalidation">4.1. Cache Invalidation Extension</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ext-commit-log" class="nav-link" id="ext-commit-log">4.2. Commit log extension</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ext-crypto" class="nav-link" id="ext-crypto">4.3. Crypto extension</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ext-jcache" class="nav-link" id="ext-jcache">4.4. JCache integration</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility" class="nav-link" id="ext-project-compatibility">4.5. Project compatibility extension</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ext-velocity" class="nav-link" id="ext-velocity">4.6. Apache Velocity Extension</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ext-osgi" class="nav-link" id="ext-osgi">4.7. Cayenne OSGI extension</a></li>
    </ul></li>
   <li><a href="/docs/5.0/cayenne-guide/build_tools" class="nav-link" id="build_tools">5. Build Tools</a>
    <ul class="sectlevel2 nav">
     <li><a href="/docs/5.0/cayenne-guide/maven_plugin" class="nav-link" id="maven_plugin">5.1. Maven Plugin</a></li>
     <li><a href="/docs/5.0/cayenne-guide/gradle_plugin" class="nav-link" id="gradle_plugin">5.2. Gradle Plugin</a></li>
     <li><a href="/docs/5.0/cayenne-guide/ant_tasks" class="nav-link" id="ant_tasks">5.3. Ant Tasks</a></li>
    </ul></li>
   <li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties" class="nav-link" id="appendix-a-configuration-properties">6. Appendix A. Configuration Properties</a></li>
   <li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections" class="nav-link" id="appendix-b-service-collections">7. Appendix B. Service Collections</a></li>
  </ul>
 </div>
                     </div>

                     <div class="cd-toc-item">
                         </div>
                 </div>
             </div>

             <div class="col-12 col-lg-8 col-xl-9  py-3 pl-lg-5  cd-content">


                 <article>
                     <header>
                     </header>
                     <section>
                         <div class="sect1">
  <h2 id="appendix-a-configuration-properties"><a class="anchor" href="#appendix-a-configuration-properties"></a>6. Appendix A. Configuration Properties</h2>
  <div class="sectionbody">
   <div class="paragraph">
    <p>Note that the property names below are defined as constants in <code>org.apache.cayenne.configuration.Constants</code> interface.</p>
   </div>
   <div id="configProperties" class="ulist">
    <ul>
     <li>
      <p><code>cayenne.jdbc.driver[.domain_name.node_name]</code> defines a JDBC driver class to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none, project DataNode configuration is used</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.url[.domain_name.node_name]</code> defines a DB URL to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none, project DataNode configuration is used</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.username[.domain_name.node_name]</code> defines a DB user name to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: any</p></li>
        <li>
         <p>Default value: none, project DataNode configuration is used</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.password[.domain_name.node_name]</code> defines a DB password to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none, project DataNode configuration is used</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.min_connections[.domain_name.node_name]</code> defines the DB connection pool minimal size. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none, project DataNode configuration is used</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.max_connections[.domain_name.node_name]</code> defines the DB connection pool maximum size. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none, project DataNode configuration is used</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.max_wait</code> defines a maximum time in milliseconds that a connection request could wait in the connection queue. After this period expires, an exception will be thrown in the calling method. A value of zero will make the thread wait until a connection is available with no time out.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: 20 seconds</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.jdbc.validation_query</code> defines a SQL string that returns some result. It will be used to validate connections in the pool.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.querycache.size</code> An integer defining the maximum number of entries in the query cache. Note that not all QueryCache providers may respect this property. MapQueryCache uses it, but the rest would use alternative configuration methods.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: any positive int value</p></li>
        <li>
         <p>Default value: 2000</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.DataRowStore.snapshot.size</code> defines snapshot cache max size</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: any positive int</p></li>
        <li>
         <p>Default value: 10000</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.contexts_sync_strategy</code> defines whether peer ObjectContexts should receive snapshot events after commits from other contexts. If true (<em>default</em>), the contexts would automatically synchronize their state with peers.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: true, false</p></li>
        <li>
         <p>Default value: false (since 4.1)</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.object_retain_strategy</code> defines fetched objects retain strategy for ObjectContexts. When weak or soft strategy is used, objects retained by ObjectContext that have no local changes can potentially get garbage collected when JVM feels like doing it.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: weak, soft, hard</p></li>
        <li>
         <p>Default value: weak</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.max_id_qualifier_size</code> defines a maximum number of ID qualifiers in the WHERE clause of queries that are generated for paginated queries and for DISJOINT_BY_ID prefetch processing. This is needed to avoid hitting WHERE clause size limitations and memory usage efficiency.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: any positive int</p></li>
        <li>
         <p>Default value: 10000</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.external_tx</code> defines whether runtime should use external transactions.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Possible values: true, false</p></li>
        <li>
         <p>Default value: false</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.query_execution_time_logging_threshold</code> defines the minimum number of milliseconds a query must run before it is logged. A value less than or equal to zero disables logging.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: 0</p></li>
       </ul>
      </div></li>
     <li>
      <p><code>cayenne.domain.name</code> defines an optional name of the runtime DataDomain. If not specified, the name is inferred from the configuration name.</p>
      <div class="ulist">
       <ul>
        <li>
         <p>Default value: none</p></li>
       </ul>
      </div></li>
    </ul>
   </div>
  </div>
 </div>
                     </section>
                     <footer>
                         <div class="row">
                             <div class="col-6 col-md-3  text-center text-md-left">
                                 &nbsp;
                             </div>
                             <div class="col-18 col-md-9  text-center text-md-right">

                                 <a class="btn btn-link" href='/docs/5.0/cayenne-guide/appendix-b-service-collections/'>
                                     <span class="d-block d-md-none  text-muted">Next: </span>
                                     Next: Cayenne Guide 5.0 · Appendix B. Service Collections
                                     <i class="small  fa fa-chevron-right  ml-3l2  d-none d-md-inline"></i>
                                 </a>

                             </div>
                         </div>
                     </footer>
                 </article>


 <img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172" />
 	        </div>
 	    </div>
 	</div>
 </main>

 <footer class="bg-dark">
     <div class="footer-nav container  text-center text-lg-left  pb-3">
         <div class="row  pt-5 pb-3">

             <div class="col-sm-6 col-lg-3">
                 <h4>About</h4>
                 <ul class="list-unstyled">

                     <li>
                         <a href="/why-cayenne.html">Why Cayenne?</a>
                     </li>

                     <li>
                         <a href="/download/">Download</a>
                     </li>

                     <li>
                         <a href="/success-stories.html">Success Stories</a>
                     </li>

                     <li>
                         <a href="/about/support/">Support</a>
                     </li>

                 </ul>
             </div>

             <div class="col-sm-6 col-lg-3">
                 <h4>Documentation</h4>
                 <ul class="list-unstyled">

                     <li>
                         <a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a>
                     </li>

                     <li>
                         <a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a>
                     </li>

                     <li>
                         <a href="/docs/4.2/getting-started-guide/">Getting Started (4.2)</a>
                     </li>

                     <li>
                         <a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a>
                     </li>

                     <li>
                         <a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a>
                     </li>

                     <li>
                         <a href="/docs/4.2/cayenne-guide/">Cayenne Guide (4.2)</a>
                     </li>

                     <li>
                         <a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a>
                     </li>

                     <li>
                         <a href="/docs/4.2/getting-started-db-first/">Database First tutorial (4.2)</a>
                     </li>

                     <li>
                         <a href="/legacy/legacy-docs/">Legacy Documentation</a>
                     </li>

                 </ul>
             </div>

             <div class="col-sm-6 col-lg-3">
                 <h4>Collaboration</h4>
                 <ul class="list-unstyled">

                     <li>
                         <a href="https://issues.apache.org/jira/browse/CAY">Bug/Feature Tracker</a>
                     </li>

                     <li>
                         <a href="/mailing-lists.html">Mailing Lists</a>
                     </li>

                     <li>
                         <a href="/dev/code-repository.html">Code Repository</a>
                     </li>

                     <li>
                         <a href="/dev/">Developer Guide</a>
                     </li>

                     <li>
                         <a href="/how-can-i-help.html">How can I help?</a>
                     </li>

                     <li>
                         <a href="/contributors.html">Contributors</a>
                     </li>

                     <li>
                         <a href="/thanks.html">Thanks</a>
                     </li>

                 </ul>
             </div>

             <div class="col-sm-6 col-lg-3">
                 <h4>News</h4>
                 <ul class="list-multiline-items list-unstyled  mb-0">

                     <li>
                         <time datetime="2023-05-25 18:00:00 &#43;0300 &#43;0300" class="xsmall d-block">May 25, 2023</time>
                         <a href="/2023/05/cayenne-42-final-released/">Cayenne 4.2 Final Released</a>
                     </li>

                     <li>
                         <time datetime="2023-03-02 12:00:00 &#43;0300 &#43;0300" class="xsmall d-block">Mar 02, 2023</time>
                         <a href="/2023/03/cayenne-403-released/">Cayenne 4.0.3 Released</a>
                     </li>

                     <li>
                         <time datetime="2022-12-05 12:00:00 &#43;0300 &#43;0300" class="xsmall d-block">Dec 05, 2022</time>
                         <a href="/2022/12/cayenne-42rc2-released/">Cayenne 4.2 Release Candidate 2 Released</a>
                     </li>

                 </ul>
                 <a class="btn-link text-uppercase xsmall" href="https://cayenne.apache.org/news">
                     More news
                     <i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i>
                 </a>
             </div>
         </div>
         <hr class="mt-0 mb-3" />
         <p class="copy xsmall text-center  mw-75 mx-auto mb-0">
             Copyright © 2001-2024 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation.
             <a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy policy</a>.
             <img class="d-block  mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" />
         </p>
     </div>
 </footer>
     </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1.3">
	<link rel="apple-touch-icon" sizes="180x180" href="/img/favicon/apple-touch-icon-04cb17e028.png">
	<link rel="icon" type="image/png" sizes="32x32" href="/img/favicon/favicon-32x32-12431ee8eb.png">
	<link rel="icon" type="image/png" sizes="16x16" href="/img/favicon/favicon-16x16-4f316e4d55.png">
	<link rel="manifest" href="/img/favicon/manifest-65e6aaa49e.json">
	<link rel="mask-icon" href="/img/favicon/safari-pinned-tab-558c1991b1.svg" color="#dc5656">
	<link rel="shortcut icon" href="/img/favicon/favicon-6cef91375b.ico">
	<meta name="msapplication-TileColor" content="#ffffff">
	<meta name="msapplication-TileImage" content="/img/favicon/mstile-144x144-34e7696278.png">
	<meta name="msapplication-config" content="/img/favicon/browserconfig-82ff158058.xml">
	<meta name="theme-color" content="#ffffff">
	<link rel="stylesheet" href="https://cayenne.apache.org/css/styles-9ee2e6e330.css"/>
	<script src="https://cayenne.apache.org/js/bundle-c0e6356367.js"></script>
	<title>Cayenne Guide 5.0 · Appendix A. Configuration Properties · Apache Cayenne</title>
	</head>
	<body class="cd-head">
	<header class="page-header">
	<nav id="topbar" class="bg-dark" aria-label="breadcrumb" role="navigation">
	<ul class="breadcrumb breadcrumb-sm breadcrumb-dark container mb-0">
	<li class="breadcrumb-item dropdown">
	<a class="dropdown-toggle text-nowrap pr-1" href="#" id="navbarDropdown" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">
	<img class="mw-15px mr-1" src="/img/feather-641aa69d09.svg" />Apache Software Foundation</a>
	<div class="dropdown-menu rounded-0" aria-labelledby="navbarDropdown">
	<a class="dropdown-item" href="https://www.apache.org">Apache Homepage</a>
	<a class="dropdown-item" href="https://www.apache.org/licenses/">License</a>
	<a class="dropdown-item" href="https://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
	<a class="dropdown-item" href="https://www.apache.org/foundation/thanks.html">Thanks</a>
	<a class="dropdown-item" href="https://www.apache.org/security/">Security</a>
	<a class="dropdown-item" href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy</a>
	<a class="ml-1 mt-1 acevent" data-format="wide" data-mode="dark" data-width="120"></a>
	</div>
	</li>
	</ul>
	</nav>
	<nav class="navbar navbar-expand-lg navbar-dark bg-primary">
	<div class="container">
	<a class="navbar-brand" href="https://cayenne.apache.org/">
	<img src="/img/logo_mono_full-d7a19eef61.svg" alt="Apache Cayenne" />
	</a>
	<button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#mainMenu" aria-controls="mainMenu" aria-expanded="false" aria-label="Toggle navigation">
	<span class="navbar-toggler-icon"></span>
	</button>

	<div class="collapse navbar-collapse" id="mainMenu">
	<ul class="navbar-nav mt-3 mt-lg-0 mr-auto">

	<li class="nav-item">
	<a class="nav-link" href="/download/">DOWNLOAD</a>
	</li>

	<li class="nav-item">
	<a class="nav-link" href="/docs/4.2/getting-started-guide/">DOCUMENTATION</a>
	</li>

	<li class="nav-item">
	<a class="nav-link" href="/about/support/">SUPPORT</a>
	</li>

	</ul>
	<ul class="navbar-nav flex-row justify-content-center mt-2 mt-lg-0 mb-2 mb-lg-0 " id="social-links-menu">
	<li class="nav-item d-flex">
	<a class="nav-link d-flex justify-content-center align-items-center" href="https://github.com/apache/cayenne">
	<img src="/img/icon_octocat_stars-c24dac94b8.svg" alt="GitHub" />
	</a>
	</li>
	<li class="nav-item d-flex">
	<a class="nav-link d-flex justify-content-center align-items-center" href="https://twitter.com/ApacheCayenne">
	<img src="/img/icon_twitter-220a129d14.svg" alt="Twitter" />
	</a>
	</li>
	</ul>
	</div>
	</div>
	</nav>
	</header>













	<main>
	<div class="cd-top-sidebar bb">
	<div class="container">
	<div class="row no-gutters">

	<div class="col-12 col-lg-4 col-xl-3 br cd-sidebar1">
	<ul class="nav" role="tablist">
	<li class="nav-item dropdown mw-100">
	<a class="nav-link dropdown-toggle text-truncate" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">
	Cayenne Version 5.0
	</a>
	<div class="dropdown-menu">
	<a class="dropdown-item" href="/docs/5.0/cayenne-guide/">Version 5.0 (Alpha)</a><a class="dropdown-item" href="/docs/4.2/getting-started-guide/">Version 4.2 (Stable)</a><a class="dropdown-item" href="/docs/4.1/getting-started-guide/">Version 4.1 (Stable)</a><a class="dropdown-item" href="/docs/4.0/getting-started-guide/">Version 4.0 (Aging)</a><a class="dropdown-item" href="/docs/3.1/getting-started-guide/">Version 3.1 (Legacy)</a>
	</div>
	</li>
	</ul>
	</div>
	<div class="col-12 col-lg-8 col-xl-9"> </div>
	</div>
	</div>
	</div>
	<div class="container">
	<div class="row no-gutters ">
	<div class="col-12 col-lg-4 col-xl-3 br py-2 bg-gray-100 cd-sidebar">
	<div class="tab-content" id="cd-docs-nav">

	<div class="cd-toc-item">

	<span class="cd-toc-link active">Cayenne Guide 5.0</span><div id="toc" class="toc toc-side">
	<div id="toctitle">
	Table of Contents
	</div>
	<ul class="sectlevel1 nav">
	<li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne" class="nav-link" id="object-relational-mapping-with-cayenne">1. Object Relational Mapping with Cayenne</a>
	<ul class="sectlevel2 nav">
	<li><a href="/docs/5.0/cayenne-guide/setup" class="nav-link" id="setup">1.1. Setup</a></li>
	<li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure" class="nav-link" id="cayenne-mapping-structure">1.2. Cayenne Mapping Structure</a></li>
	<li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" class="nav-link" id="cayenne-modeler">1.3. CayenneModeler Application</a></li>
	</ul></li>
	<li><a href="/docs/5.0/cayenne-guide/cayenne-framework" class="nav-link" id="cayenne-framework">2. Cayenne Framework</a>
	<ul class="sectlevel2 nav">
	<li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project" class="nav-link" id="including-cayenne-in-project">2.1. Including Cayenne in a Project</a></li>
	<li><a href="/docs/5.0/cayenne-guide/starting-cayenne" class="nav-link" id="starting-cayenne">2.2. Starting Cayenne</a></li>
	<li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext" class="nav-link" id="persistent-objects-objectcontext">2.3. Persistent Objects and ObjectContext</a></li>
	<li><a href="/docs/5.0/cayenne-guide/expressions" class="nav-link" id="expressions">2.4. Expressions</a></li>
	<li><a href="/docs/5.0/cayenne-guide/orderings" class="nav-link" id="orderings">2.5. Orderings</a></li>
	<li><a href="/docs/5.0/cayenne-guide/queries" class="nav-link" id="queries">2.6. Queries</a></li>
	<li><a href="/docs/5.0/cayenne-guide/lifecycle-events" class="nav-link" id="lifecycle-events">2.7. Lifecycle Events</a></li>
	<li><a href="/docs/5.0/cayenne-guide/performance-tuning" class="nav-link" id="performance-tuning">2.8. Performance Tuning</a></li>
	<li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime" class="nav-link" id="customizing-cayenne-runtime">2.9. Customizing Cayenne Runtime</a></li>
	</ul></li>
	<li><a href="/docs/5.0/cayenne-guide/db-first-flow" class="nav-link" id="db-first-flow">3. DB-First Flow</a>
	<ul class="sectlevel2 nav">
	<li><a href="/docs/5.0/cayenne-guide/re-introduction" class="nav-link" id="re-introduction">3.1. Introduction</a></li>
	<li><a href="/docs/5.0/cayenne-guide/re-filtering" class="nav-link" id="re-filtering">3.2. Filtering</a></li>
	<li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control" class="nav-link" id="re-relationships-loading-control">3.3. Other Settings</a></li>
	<li><a href="/docs/5.0/cayenne-guide/re-modeler" class="nav-link" id="re-modeler">3.4. Reverse Engineering in Cayenne Modeler</a></li>
	</ul></li>
	<li><a href="/docs/5.0/cayenne-guide/additional-modules" class="nav-link" id="additional-modules">4. Additional Modules</a>
	<ul class="sectlevel2 nav">
	<li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation" class="nav-link" id="ext-cache-invalidation">4.1. Cache Invalidation Extension</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ext-commit-log" class="nav-link" id="ext-commit-log">4.2. Commit log extension</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ext-crypto" class="nav-link" id="ext-crypto">4.3. Crypto extension</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ext-jcache" class="nav-link" id="ext-jcache">4.4. JCache integration</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility" class="nav-link" id="ext-project-compatibility">4.5. Project compatibility extension</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ext-velocity" class="nav-link" id="ext-velocity">4.6. Apache Velocity Extension</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ext-osgi" class="nav-link" id="ext-osgi">4.7. Cayenne OSGI extension</a></li>
	</ul></li>
	<li><a href="/docs/5.0/cayenne-guide/build_tools" class="nav-link" id="build_tools">5. Build Tools</a>
	<ul class="sectlevel2 nav">
	<li><a href="/docs/5.0/cayenne-guide/maven_plugin" class="nav-link" id="maven_plugin">5.1. Maven Plugin</a></li>
	<li><a href="/docs/5.0/cayenne-guide/gradle_plugin" class="nav-link" id="gradle_plugin">5.2. Gradle Plugin</a></li>
	<li><a href="/docs/5.0/cayenne-guide/ant_tasks" class="nav-link" id="ant_tasks">5.3. Ant Tasks</a></li>
	</ul></li>
	<li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties" class="nav-link" id="appendix-a-configuration-properties">6. Appendix A. Configuration Properties</a></li>
	<li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections" class="nav-link" id="appendix-b-service-collections">7. Appendix B. Service Collections</a></li>
	</ul>
	</div>
	</div>

	<div class="cd-toc-item">
	</div>
	</div>
	</div>

	<div class="col-12 col-lg-8 col-xl-9 py-3 pl-lg-5 cd-content">














































































	<article>
	<header>
	</header>
	<section>
	<div class="sect1">
	<h2 id="appendix-a-configuration-properties"><a class="anchor" href="#appendix-a-configuration-properties"></a>6. Appendix A. Configuration Properties</h2>
	<div class="sectionbody">
	<div class="paragraph">
	<p>Note that the property names below are defined as constants in <code>org.apache.cayenne.configuration.Constants</code> interface.</p>
	</div>
	<div id="configProperties" class="ulist">
	<ul>
	<li>
	<p><code>cayenne.jdbc.driver[.domain_name.node_name]</code> defines a JDBC driver class to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none, project DataNode configuration is used</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.url[.domain_name.node_name]</code> defines a DB URL to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none, project DataNode configuration is used</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.username[.domain_name.node_name]</code> defines a DB user name to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: any</p></li>
	<li>
	<p>Default value: none, project DataNode configuration is used</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.password[.domain_name.node_name]</code> defines a DB password to use when creating a DataSource. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none, project DataNode configuration is used</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.min_connections[.domain_name.node_name]</code> defines the DB connection pool minimal size. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none, project DataNode configuration is used</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.max_connections[.domain_name.node_name]</code> defines the DB connection pool maximum size. If domain name and optionally - node name are specified, the setting overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none, project DataNode configuration is used</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.max_wait</code> defines a maximum time in milliseconds that a connection request could wait in the connection queue. After this period expires, an exception will be thrown in the calling method. A value of zero will make the thread wait until a connection is available with no time out.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: 20 seconds</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.jdbc.validation_query</code> defines a SQL string that returns some result. It will be used to validate connections in the pool.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.querycache.size</code> An integer defining the maximum number of entries in the query cache. Note that not all QueryCache providers may respect this property. MapQueryCache uses it, but the rest would use alternative configuration methods.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: any positive int value</p></li>
	<li>
	<p>Default value: 2000</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.DataRowStore.snapshot.size</code> defines snapshot cache max size</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: any positive int</p></li>
	<li>
	<p>Default value: 10000</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.contexts_sync_strategy</code> defines whether peer ObjectContexts should receive snapshot events after commits from other contexts. If true (<em>default</em>), the contexts would automatically synchronize their state with peers.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: true, false</p></li>
	<li>
	<p>Default value: false (since 4.1)</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.object_retain_strategy</code> defines fetched objects retain strategy for ObjectContexts. When weak or soft strategy is used, objects retained by ObjectContext that have no local changes can potentially get garbage collected when JVM feels like doing it.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: weak, soft, hard</p></li>
	<li>
	<p>Default value: weak</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.max_id_qualifier_size</code> defines a maximum number of ID qualifiers in the WHERE clause of queries that are generated for paginated queries and for DISJOINT_BY_ID prefetch processing. This is needed to avoid hitting WHERE clause size limitations and memory usage efficiency.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: any positive int</p></li>
	<li>
	<p>Default value: 10000</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.external_tx</code> defines whether runtime should use external transactions.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Possible values: true, false</p></li>
	<li>
	<p>Default value: false</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.query_execution_time_logging_threshold</code> defines the minimum number of milliseconds a query must run before it is logged. A value less than or equal to zero disables logging.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: 0</p></li>
	</ul>
	</div></li>
	<li>
	<p><code>cayenne.domain.name</code> defines an optional name of the runtime DataDomain. If not specified, the name is inferred from the configuration name.</p>
	<div class="ulist">
	<ul>
	<li>
	<p>Default value: none</p></li>
	</ul>
	</div></li>
	</ul>
	</div>
	</div>
	</div>
	</section>
	<footer>
	<div class="row">
	<div class="col-6 col-md-3 text-center text-md-left">

	</div>
	<div class="col-18 col-md-9 text-center text-md-right">

	<a class="btn btn-link" href='/docs/5.0/cayenne-guide/appendix-b-service-collections/'>
	<span class="d-block d-md-none text-muted">Next: </span>
	Next: Cayenne Guide 5.0 · Appendix B. Service Collections
	<i class="small fa fa-chevron-right ml-3l2 d-none d-md-inline"></i>
	</a>

	</div>
	</div>
	</footer>
	</article>


	<img referrerpolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=5c836e39-be6b-4a21-a946-a97b5b69f172" />
	</div>
	</div>
	</div>
	</main>

	<footer class="bg-dark">
	<div class="footer-nav container text-center text-lg-left pb-3">
	<div class="row pt-5 pb-3">

	<div class="col-sm-6 col-lg-3">
	<h4>About</h4>
	<ul class="list-unstyled">

	<li>
	<a href="/why-cayenne.html">Why Cayenne?</a>
	</li>

	<li>
	<a href="/download/">Download</a>
	</li>

	<li>
	<a href="/success-stories.html">Success Stories</a>
	</li>

	<li>
	<a href="/about/support/">Support</a>
	</li>

	</ul>
	</div>

	<div class="col-sm-6 col-lg-3">
	<h4>Documentation</h4>
	<ul class="list-unstyled">

	<li>
	<a href="/docs/4.0/getting-started-guide/">Getting Started (4.0)</a>
	</li>

	<li>
	<a href="/docs/4.1/getting-started-guide/">Getting Started (4.1)</a>
	</li>

	<li>
	<a href="/docs/4.2/getting-started-guide/">Getting Started (4.2)</a>
	</li>

	<li>
	<a href="/docs/4.0/cayenne-guide/">Cayenne Guide (4.0)</a>
	</li>

	<li>
	<a href="/docs/4.1/cayenne-guide/">Cayenne Guide (4.1)</a>
	</li>

	<li>
	<a href="/docs/4.2/cayenne-guide/">Cayenne Guide (4.2)</a>
	</li>

	<li>
	<a href="/docs/4.1/getting-started-db-first/">Database First tutorial (4.1)</a>
	</li>

	<li>
	<a href="/docs/4.2/getting-started-db-first/">Database First tutorial (4.2)</a>
	</li>

	<li>
	<a href="/legacy/legacy-docs/">Legacy Documentation</a>
	</li>

	</ul>
	</div>

	<div class="col-sm-6 col-lg-3">
	<h4>Collaboration</h4>
	<ul class="list-unstyled">

	<li>
	<a href="https://issues.apache.org/jira/browse/CAY">Bug/Feature Tracker</a>
	</li>

	<li>
	<a href="/mailing-lists.html">Mailing Lists</a>
	</li>

	<li>
	<a href="/dev/code-repository.html">Code Repository</a>
	</li>

	<li>
	<a href="/dev/">Developer Guide</a>
	</li>

	<li>
	<a href="/how-can-i-help.html">How can I help?</a>
	</li>

	<li>
	<a href="/contributors.html">Contributors</a>
	</li>

	<li>
	<a href="/thanks.html">Thanks</a>
	</li>

	</ul>
	</div>

	<div class="col-sm-6 col-lg-3">
	<h4>News</h4>
	<ul class="list-multiline-items list-unstyled mb-0">

	<li>
	<time datetime="2023-05-25 18:00:00 +0300 +0300" class="xsmall d-block">May 25, 2023</time>
	<a href="/2023/05/cayenne-42-final-released/">Cayenne 4.2 Final Released</a>
	</li>

	<li>
	<time datetime="2023-03-02 12:00:00 +0300 +0300" class="xsmall d-block">Mar 02, 2023</time>
	<a href="/2023/03/cayenne-403-released/">Cayenne 4.0.3 Released</a>
	</li>

	<li>
	<time datetime="2022-12-05 12:00:00 +0300 +0300" class="xsmall d-block">Dec 05, 2022</time>
	<a href="/2022/12/cayenne-42rc2-released/">Cayenne 4.2 Release Candidate 2 Released</a>
	</li>

	</ul>
	<a class="btn-link text-uppercase xsmall" href="https://cayenne.apache.org/news">
	More news
	<i class="fa fa-lg fa-long-arrow-right" aria-hidden="true"></i>
	</a>
	</div>
	</div>
	<hr class="mt-0 mb-3" />
	<p class="copy xsmall text-center mw-75 mx-auto mb-0">
	Copyright © 2001-2024 Apache Software Foundation. Apache Cayenne, Cayenne, Apache, the Apache feather logo, and the Apache Cayenne project logo are trademarks of The Apache Software Foundation.
	<a href="https://privacy.apache.org/policies/privacy-policy-public.html">Privacy policy</a>.
	<img class="d-block mx-auto mt-2" src="/img/logo_mono-3302daa3cf.svg" alt="Apache Cayenne" />
	</p>
	</div>
	</footer>
	</body>
	</html>