This is an automated email from the ASF dual-hosted git repository.
ntimofeev pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/cayenne-website.git
The following commit(s) were added to refs/heads/master by this push:
new f60a715f7 Next link in the docs
f60a715f7 is described below
commit f60a715f74a075385d808da03708be8fa51d1960
Author: Nikita Timofeev <[email protected]>
AuthorDate: Mon Apr 15 17:10:45 2024 +0400
Next link in the docs
---
.../site/content/docs/5.0/cayenne-guide.toc.html | 98 ++--
.../docs/5.0/cayenne-guide/additional-modules.html | 2 +
.../content/docs/5.0/cayenne-guide/ant_tasks.html | 2 +
.../appendix-a-configuration-properties.html | 119 +++--
.../appendix-b-service-collections.html | 65 ++-
.../docs/5.0/cayenne-guide/build_tools.html | 2 +
.../docs/5.0/cayenne-guide/cayenne-framework.html | 2 +
.../cayenne-guide/cayenne-mapping-structure.html | 2 +
.../docs/5.0/cayenne-guide/cayenne-modeler.html | 17 +-
.../cayenne-guide/customizing-cayenne-runtime.html | 2 +
.../docs/5.0/cayenne-guide/db-first-flow.html | 2 +
.../docs/5.0/cayenne-guide/expressions.html | 32 +-
.../5.0/cayenne-guide/ext-cache-invalidation.html | 2 +
.../docs/5.0/cayenne-guide/ext-commit-log.html | 11 +-
.../content/docs/5.0/cayenne-guide/ext-crypto.html | 8 +-
.../content/docs/5.0/cayenne-guide/ext-jcache.html | 2 +
.../content/docs/5.0/cayenne-guide/ext-osgi.html | 2 +
.../cayenne-guide/ext-project-compatibility.html | 2 +
.../docs/5.0/cayenne-guide/ext-velocity.html | 2 +
.../docs/5.0/cayenne-guide/gradle_plugin.html | 2 +
.../including-cayenne-in-project.html | 2 +
.../docs/5.0/cayenne-guide/lifecycle-events.html | 56 ++-
.../docs/5.0/cayenne-guide/maven_plugin.html | 546 ++++++++++++++-------
.../object-relational-mapping-with-cayenne.html | 2 +
.../content/docs/5.0/cayenne-guide/orderings.html | 2 +
.../docs/5.0/cayenne-guide/performance-tuning.html | 23 +-
.../persistent-objects-objectcontext.html | 38 +-
.../content/docs/5.0/cayenne-guide/queries.html | 38 +-
.../docs/5.0/cayenne-guide/re-filtering.html | 2 +
.../docs/5.0/cayenne-guide/re-introduction.html | 14 +-
.../content/docs/5.0/cayenne-guide/re-modeler.html | 50 +-
.../re-relationships-loading-control.html | 2 +
.../site/content/docs/5.0/cayenne-guide/setup.html | 89 ++--
.../docs/5.0/cayenne-guide/starting-cayenne.html | 20 +-
src/main/site/layouts/docs/single.html | 29 ++
35 files changed, 867 insertions(+), 422 deletions(-)
diff --git a/src/main/site/content/docs/5.0/cayenne-guide.toc.html
b/src/main/site/content/docs/5.0/cayenne-guide.toc.html
index d55219e76..fafc8c631 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide.toc.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide.toc.html
@@ -1,52 +1,50 @@
<div id="toc" class="toc toc-side">
-<ul class="sectlevel1 nav">
- <li><a href="/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne"
id="object-relational-mapping-with-cayenne" class="nav-link">1. Object
Relational Mapping with Cayenne</a>
-<ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/setup" id="setup" class="nav-link">1.1.
Setup</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-mapping-structure"
id="cayenne-mapping-structure" class="nav-link">1.2. Cayenne Mapping
Structure</a></li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-modeler" id="cayenne-modeler"
class="nav-link">1.3. CayenneModeler Application</a></li>
-</ul>
-</li>
- <li><a href="/docs/5.0/cayenne-guide/cayenne-framework"
id="cayenne-framework" class="nav-link">2. Cayenne Framework</a>
-<ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/including-cayenne-in-project"
id="including-cayenne-in-project" class="nav-link">2.1. Including Cayenne in a
Project</a></li>
- <li><a href="/docs/5.0/cayenne-guide/starting-cayenne" id="starting-cayenne"
class="nav-link">2.2. Starting Cayenne</a></li>
- <li><a href="/docs/5.0/cayenne-guide/persistent-objects-objectcontext"
id="persistent-objects-objectcontext" class="nav-link">2.3. Persistent Objects
and ObjectContext</a></li>
- <li><a href="/docs/5.0/cayenne-guide/expressions" id="expressions"
class="nav-link">2.4. Expressions</a></li>
- <li><a href="/docs/5.0/cayenne-guide/orderings" id="orderings"
class="nav-link">2.5. Orderings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/queries" id="queries"
class="nav-link">2.6. Queries</a></li>
- <li><a href="/docs/5.0/cayenne-guide/lifecycle-events" id="lifecycle-events"
class="nav-link">2.7. Lifecycle Events</a></li>
- <li><a href="/docs/5.0/cayenne-guide/performance-tuning"
id="performance-tuning" class="nav-link">2.8. Performance Tuning</a></li>
- <li><a href="/docs/5.0/cayenne-guide/customizing-cayenne-runtime"
id="customizing-cayenne-runtime" class="nav-link">2.9. Customizing Cayenne
Runtime</a></li>
-</ul>
-</li>
- <li><a href="/docs/5.0/cayenne-guide/db-first-flow" id="db-first-flow"
class="nav-link">3. DB-First Flow</a>
-<ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/re-introduction" id="re-introduction"
class="nav-link">3.1. Introduction</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-filtering" id="re-filtering"
class="nav-link">3.2. Filtering</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-relationships-loading-control"
id="re-relationships-loading-control" class="nav-link">3.3. Other
Settings</a></li>
- <li><a href="/docs/5.0/cayenne-guide/re-modeler" id="re-modeler"
class="nav-link">3.4. Reverse Engineering in Cayenne Modeler</a></li>
-</ul>
-</li>
- <li><a href="/docs/5.0/cayenne-guide/additional-modules"
id="additional-modules" class="nav-link">4. Additional Modules</a>
-<ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/ext-cache-invalidation"
id="ext-cache-invalidation" class="nav-link">4.1. Cache Invalidation
Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-commit-log" id="ext-commit-log"
class="nav-link">4.2. Commit log extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-crypto" id="ext-crypto"
class="nav-link">4.3. Crypto extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-jcache" id="ext-jcache"
class="nav-link">4.4. JCache integration</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-project-compatibility"
id="ext-project-compatibility" class="nav-link">4.5. Project compatibility
extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-velocity" id="ext-velocity"
class="nav-link">4.6. Apache Velocity Extension</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ext-osgi" id="ext-osgi"
class="nav-link">4.7. Cayenne OSGI extension</a></li>
-</ul>
-</li>
- <li><a href="/docs/5.0/cayenne-guide/build_tools" id="build_tools"
class="nav-link">5. Build Tools</a>
-<ul class="sectlevel2 nav">
- <li><a href="/docs/5.0/cayenne-guide/maven_plugin" id="maven_plugin"
class="nav-link">5.1. Maven Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/gradle_plugin" id="gradle_plugin"
class="nav-link">5.2. Gradle Plugin</a></li>
- <li><a href="/docs/5.0/cayenne-guide/ant_tasks" id="ant_tasks"
class="nav-link">5.3. Ant Tasks</a></li>
-</ul>
-</li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-a-configuration-properties"
id="appendix-a-configuration-properties" class="nav-link">6. Appendix A.
Configuration Properties</a></li>
- <li><a href="/docs/5.0/cayenne-guide/appendix-b-service-collections"
id="appendix-b-service-collections" class="nav-link">7. Appendix B. Service
Collections</a></li>
-</ul>
+ <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>
\ No newline at end of file
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
b/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
index 35b29d892..6181e465a 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/additional-modules.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Additional Modules"
description: "Cayenne Guide 5.0, Additional Modules"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 200
---
<div><h2>4. Additional Modules</h2>
<ul>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
b/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
index 4a1043607..732afe663 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ant_tasks.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Ant Tasks"
description: "Cayenne Guide 5.0, Ant Tasks"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 310
---
<div class="sect2">
<h3 id="ant_tasks"><a class="anchor" href="#ant_tasks"></a>5.3. Ant Tasks</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
index 87bbb87d6..a21ec35dc 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-a-configuration-properties.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Appendix A. Configuration
Properties"
description: "Cayenne Guide 5.0, Appendix A. Configuration Properties"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 320
---
<div class="sect1">
<h2 id="appendix-a-configuration-properties"><a class="anchor"
href="#appendix-a-configuration-properties"></a>6. Appendix A. Configuration
Properties</h2>
@@ -29,107 +31,146 @@ cayenneNoToc: true
</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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <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>
+ <li>
+ <p>Default value: none</p></li>
</ul>
</div></li>
</ul>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
index 4307109fa..b80f59f5a 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/appendix-b-service-collections.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Appendix B. Service Collections"
description: "Cayenne Guide 5.0, Appendix B. Service Collections"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 330
---
<div class="sect1">
<h2 id="appendix-b-service-collections"><a class="anchor"
href="#appendix-b-service-collections"></a>7. Appendix B. Service
Collections</h2>
@@ -45,39 +47,60 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.properties</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>Map<String,String></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Properties used by built-in Cayenne services. The keys in
this map are the property names from the table in Appendix A.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.properties</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>Map<String,String></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Properties used by built-in Cayenne services. The
keys in this map are the property names from the table in Appendix A.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.adapter_detectors</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>List<DbAdapterDetector></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Contains objects that can discover the type of current
database and install the correct DbAdapter in runtime.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.adapter_detectors</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>List<DbAdapterDetector></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Contains objects that can discover the type of
current database and install the correct DbAdapter in runtime.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.domain_listeners</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>List<Object></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Stores DataDomain listeners.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.domain_listeners</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>List<Object></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Stores DataDomain listeners.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.project_locations</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>List<String></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Stores locations of the one of more project configuration
files.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.project_locations</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>List<String></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Stores locations of the one of more project
configuration files.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.default_types</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>List<ExtendedType></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Stores default adapter-agnostic ExtendedTypes. Default
ExtendedTypes can be overridden / extended by DB-specific DbAdapters as well as
by user-provided types configured in another colltecion (see
<code>"cayenne.user_types"</code>).</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.default_types</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>List<ExtendedType></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Stores default adapter-agnostic ExtendedTypes.
Default ExtendedTypes can be overridden / extended by DB-specific DbAdapters as
well as by user-provided types configured in another colltecion (see
<code>"cayenne.user_types"</code>).</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.user_types</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>List<ExtendedType></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Stores a user-provided ExtendedTypes. This collection will
be merged into a full list of ExtendedTypes and would override any
ExtendedTypes defined in a default list, or by a DbAdapter.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.user_types</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>List<ExtendedType></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Stores a user-provided ExtendedTypes. This
collection will be merged into a full list of ExtendedTypes and would override
any ExtendedTypes defined in a default list, or by a DbAdapter.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>cayenne.type_factories</code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock"><code>List<ExtendedTypeFactory></code></p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Stores default and user-provided ExtendedTypeFactories.
ExtendedTypeFactory allows to define ExtendedTypes dynamically for the whole
group of Java classes. E.g. Cayenne supplies a factory to map all Enums
regardless of their type.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock"><code>cayenne.type_factories</code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p
class="tableblock"><code>List<ExtendedTypeFactory></code></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Stores default and user-provided
ExtendedTypeFactories. ExtendedTypeFactory allows to define ExtendedTypes
dynamically for the whole group of Java classes. E.g. Cayenne supplies a
factory to map all Enums regardless of their type.</p></td>
</tr>
</tbody>
</table>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
b/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
index 60487f440..97d17926b 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/build_tools.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Build Tools"
description: "Cayenne Guide 5.0, Build Tools"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 280
---
<div><h2>5. Build Tools</h2>
<ul>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/cayenne-framework.html
b/src/main/site/content/docs/5.0/cayenne-guide/cayenne-framework.html
index 0bdb4b9d7..94d4903ff 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/cayenne-framework.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/cayenne-framework.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Cayenne Framework"
description: "Cayenne Guide 5.0, Cayenne Framework"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 50
---
<div><h2>2. Cayenne Framework</h2>
<ul>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/cayenne-mapping-structure.html
b/src/main/site/content/docs/5.0/cayenne-guide/cayenne-mapping-structure.html
index 256d50b3e..79e6f7b0e 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/cayenne-mapping-structure.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/cayenne-mapping-structure.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Cayenne Mapping Structure"
description: "Cayenne Guide 5.0, Cayenne Mapping Structure"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 30
---
<div class="sect2">
<h3 id="cayenne-mapping-structure"><a class="anchor"
href="#cayenne-mapping-structure"></a>1.2. Cayenne Mapping Structure</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/cayenne-modeler.html
b/src/main/site/content/docs/5.0/cayenne-guide/cayenne-modeler.html
index 22cfd8497..7b7ba1245 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/cayenne-modeler.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/cayenne-modeler.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · CayenneModeler Application"
description: "Cayenne Guide 5.0, CayenneModeler Application"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 40
---
<div class="sect2">
<h3 id="cayenne-modeler"><a class="anchor" href="#cayenne-modeler"></a>1.3.
CayenneModeler Application</h3>
@@ -51,7 +53,8 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><strong>Standard Persistent Objects</strong></p></li>
+ <li>
+ <p><strong>Standard Persistent Objects</strong></p></li>
</ul>
</div>
<div class="paragraph">
@@ -59,7 +62,8 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><strong>Advanced</strong></p></li>
+ <li>
+ <p><strong>Advanced</strong></p></li>
</ul>
</div>
<div class="paragraph">
@@ -85,9 +89,12 @@ cayenneNoToc: true
</div>
<div class="olist arabic">
<ol class="arabic">
- <li><p><strong>Cayenne Generated</strong>. This is default strategy.
Cayenne will use special table <code>AUTO_PK_SUPPORT</code> for managing
primary keys.</p></li>
- <li><p><strong>Database Generated</strong>. Cayenne will delegate PK
generation to database (e.g. auto increment fields on MySQL or
<code>serial</code> type on PostgreSQL)</p></li>
- <li><p><strong>Custom Sequence</strong>. In this case Cayenne will use
provided sequence to generate primary keys.</p></li>
+ <li>
+ <p><strong>Cayenne Generated</strong>. This is default strategy. Cayenne
will use special table <code>AUTO_PK_SUPPORT</code> for managing primary
keys.</p></li>
+ <li>
+ <p><strong>Database Generated</strong>. Cayenne will delegate PK
generation to database (e.g. auto increment fields on MySQL or
<code>serial</code> type on PostgreSQL)</p></li>
+ <li>
+ <p><strong>Custom Sequence</strong>. In this case Cayenne will use
provided sequence to generate primary keys.</p></li>
</ol>
</div>
<div class="paragraph">
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/customizing-cayenne-runtime.html
b/src/main/site/content/docs/5.0/cayenne-guide/customizing-cayenne-runtime.html
index 1ac9648e8..72dd26f38 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/customizing-cayenne-runtime.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/customizing-cayenne-runtime.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Customizing Cayenne Runtime"
description: "Cayenne Guide 5.0, Customizing Cayenne Runtime"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 140
---
<div class="sect2">
<h3 id="customizing-cayenne-runtime"><a class="anchor"
href="#customizing-cayenne-runtime"></a>2.9. Customizing Cayenne Runtime</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
b/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
index 590a98936..4663b1fcc 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/db-first-flow.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · DB-First Flow"
description: "Cayenne Guide 5.0, DB-First Flow"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 150
---
<div><h2>3. DB-First Flow</h2>
<ul>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/expressions.html
b/src/main/site/content/docs/5.0/cayenne-guide/expressions.html
index 7b7eccf86..62fa0e145 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/expressions.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/expressions.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Expressions"
description: "Cayenne Guide 5.0, Expressions"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 90
---
<div class="sect2">
<h3 id="expressions"><a class="anchor" href="#expressions"></a>2.4.
Expressions</h3>
@@ -38,9 +40,12 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><code>db:</code> is an optional prefix indicating that the
following path is a DB path. Otherwise it is an object path.</p></li>
- <li><p><code>segment</code> is a name of a property (relationship or
attribute in Cayenne terms) in the path. The path must have at least one
segment; segments are separated by dot (".").</p></li>
- <li><p><code>+</code> An "OUTER JOIN" path component. Currently "+" only
has effect when translated to SQL as OUTER JOIN. When evaluating expressions in
memory, it is ignored.</p></li>
+ <li>
+ <p><code>db:</code> is an optional prefix indicating that the following
path is a DB path. Otherwise it is an object path.</p></li>
+ <li>
+ <p><code>segment</code> is a name of a property (relationship or
attribute in Cayenne terms) in the path. The path must have at least one
segment; segments are separated by dot (".").</p></li>
+ <li>
+ <p>`` An "OUTER JOIN" path component. Currently "" only has effect when
translated to SQL as OUTER JOIN. When evaluating expressions in memory, it is
ignored.</p></li>
</ul>
</div>
<div class="paragraph">
@@ -48,9 +53,12 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><code>name</code> - can be used to navigate (read) the "name"
property of a Person (or any other type of object that has a "name"
property).</p></li>
- <li><p><code>artist.exhibits.closingDate</code> - can be used to navigate
to a closing date of any of the exhibits of a Painting’s Artist object.</p></li>
- <li><p><code>artist.exhibits+.closingDate</code> - same as the previous
example, but when translated into SQL, an OUTER JOIN will be used for
"exhibits".</p></li>
+ <li>
+ <p><code>name</code> - can be used to navigate (read) the "name" property
of a Person (or any other type of object that has a "name" property).</p></li>
+ <li>
+ <p><code>artist.exhibits.closingDate</code> - can be used to navigate to
a closing date of any of the exhibits of a Painting’s Artist object.</p></li>
+ <li>
+ <p><code>artist.exhibits+.closingDate</code> - same as the previous
example, but when translated into SQL, an OUTER JOIN will be used for
"exhibits".</p></li>
</ul>
</div>
<div class="paragraph">
@@ -58,8 +66,10 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><code>db:NAME</code> - can be used to navigate to a value in the
"NAME" column of some unspecified table.</p></li>
- <li><p><code>db:artist.artistExhibits.exhibit.CLOSING_DATE</code> - can be
used to match a closing date of any of the exhibits of a related artist
record.</p></li>
+ <li>
+ <p><code>db:NAME</code> - can be used to navigate to a value in the
"NAME" column of some unspecified table.</p></li>
+ <li>
+ <p><code>db:artist.artistExhibits.exhibit.CLOSING_DATE</code> - can be
used to match a closing date of any of the exhibits of a related artist
record.</p></li>
</ul>
</div>
<div class="paragraph">
@@ -67,8 +77,10 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><code>artist.exhibits.closingDate</code> - full path</p></li>
- <li><p><code>e.closingDate</code> - alias "e" is used for
<code>artist.exhibits</code>.</p></li>
+ <li>
+ <p><code>artist.exhibits.closingDate</code> - full path</p></li>
+ <li>
+ <p><code>e.closingDate</code> - alias "e" is used for
<code>artist.exhibits</code>.</p></li>
</ul>
</div>
<div class="paragraph">
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
index 6f74f93d2..184ebbe61 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-cache-invalidation.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Cache Invalidation Extension"
description: "Cayenne Guide 5.0, Cache Invalidation Extension"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 210
---
<div class="sect2">
<h3 id="ext-cache-invalidation"><a class="anchor"
href="#ext-cache-invalidation"></a>4.1. Cache Invalidation Extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-commit-log.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-commit-log.html
index 176683095..957be5b41 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-commit-log.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-commit-log.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Commit log extension"
description: "Cayenne Guide 5.0, Commit log extension"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 220
---
<div class="sect2">
<h3 id="ext-commit-log"><a class="anchor" href="#ext-commit-log"></a>4.2.
Commit log extension</h3>
@@ -53,7 +55,8 @@ cayenneNoToc: true
</div>
<div class="olist arabic">
<ol class="arabic">
- <li><p>Mark all entities which changes you are interested in with
<code>@org.apache.cayenne.commitlog.CommitLog</code> annotation</p>
+ <li>
+ <p>Mark all entities which changes you are interested in with
<code>@org.apache.cayenne.commitlog.CommitLog</code> annotation</p>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-Java Java"
data-lang="Java">@CommitLog(ignoredProperties = {"somePrivatePropertyToSkip"})
@@ -62,7 +65,8 @@ public class MyEntity extends _MyEntity {
}</code></pre>
</div>
</div></li>
- <li><p>Implement <code>CommitLogListener</code> interface.</p>
+ <li>
+ <p>Implement <code>CommitLogListener</code> interface.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java java"
data-lang="java">public class MyCommitLogListener implements CommitLogListener {
@@ -78,7 +82,8 @@ public class MyEntity extends _MyEntity {
}</code></pre>
</div>
</div></li>
- <li><p>Register your listener implementation.</p>
+ <li>
+ <p>Register your listener implementation.</p>
<div class="listingblock">
<div class="content">
<pre class="highlight"><code class="language-java java"
data-lang="java">CayenneRuntime.builder()
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
index 0c220c22b..b8e0e73b4 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-crypto.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Crypto extension"
description: "Cayenne Guide 5.0, Crypto extension"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 230
---
<div class="sect2">
<h3 id="ext-crypto"><a class="anchor" href="#ext-crypto"></a>4.3. Crypto
extension</h3>
@@ -58,8 +60,10 @@ cayenneNoToc: true
</div>
<div class="olist arabic">
<ol class="arabic">
- <li><p>Binary types: <code>BINARY, BLOB, VARBINARY, LONGVARBINARY</code>.
These types are preferred.</p></li>
- <li><p>Character types, that will store <code>base64</code> encoded
value: <code>CHAR, NCHAR, CLOB, NCLOB, LONGVARCHAR, LONGNVARCHAR, VARCHAR,
NVARCHAR</code>.</p></li>
+ <li>
+ <p>Binary types: <code>BINARY, BLOB, VARBINARY, LONGVARBINARY</code>.
These types are preferred.</p></li>
+ <li>
+ <p>Character types, that will store <code>base64</code> encoded value:
<code>CHAR, NCHAR, CLOB, NCLOB, LONGVARCHAR, LONGNVARCHAR, VARCHAR,
NVARCHAR</code>.</p></li>
</ol>
</div>
<div class="admonitionblock note">
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
index 7a4ce513d..ffa01ea7d 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-jcache.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · JCache integration"
description: "Cayenne Guide 5.0, JCache integration"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 240
---
<div class="sect2">
<h3 id="ext-jcache"><a class="anchor" href="#ext-jcache"></a>4.4. JCache
integration</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
index 0c80adcfb..a6a79c034 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-osgi.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Cayenne OSGI extension"
description: "Cayenne Guide 5.0, Cayenne OSGI extension"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 270
---
<div class="sect2">
<h3 id="ext-osgi"><a class="anchor" href="#ext-osgi"></a>4.7. Cayenne OSGI
extension</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
index 08e8089db..a69eb0172 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/ext-project-compatibility.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Project compatibility extension"
description: "Cayenne Guide 5.0, Project compatibility extension"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 250
---
<div class="sect2">
<h3 id="ext-project-compatibility"><a class="anchor"
href="#ext-project-compatibility"></a>4.5. Project compatibility extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
b/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
index 08ec73e0c..b173eff24 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/ext-velocity.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Apache Velocity Extension"
description: "Cayenne Guide 5.0, Apache Velocity Extension"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 260
---
<div class="sect2">
<h3 id="ext-velocity"><a class="anchor" href="#ext-velocity"></a>4.6. Apache
Velocity Extension</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
b/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
index 1219b1a46..2b27a4923 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/gradle_plugin.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Gradle Plugin"
description: "Cayenne Guide 5.0, Gradle Plugin"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 300
---
<div class="sect2">
<h3 id="gradle_plugin"><a class="anchor" href="#gradle_plugin"></a>5.2.
Gradle Plugin</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/including-cayenne-in-project.html
b/src/main/site/content/docs/5.0/cayenne-guide/including-cayenne-in-project.html
index 7db1b860b..04262ad63 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/including-cayenne-in-project.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/including-cayenne-in-project.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Including Cayenne in a Project"
description: "Cayenne Guide 5.0, Including Cayenne in a Project"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 60
---
<div class="sect2">
<h3 id="including-cayenne-in-project"><a class="anchor"
href="#including-cayenne-in-project"></a>2.1. Including Cayenne in a
Project</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/lifecycle-events.html
b/src/main/site/content/docs/5.0/cayenne-guide/lifecycle-events.html
index 939cd3093..d3debb5e3 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/lifecycle-events.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/lifecycle-events.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Lifecycle Events"
description: "Cayenne Guide 5.0, Lifecycle Events"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 120
---
<div class="sect2">
<h3 id="lifecycle-events"><a class="anchor" href="#lifecycle-events"></a>2.7.
Lifecycle Events</h3>
@@ -53,42 +55,60 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PostAdd</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right after a new object is created inside
<code>ObjectContext.newObject()</code>. When this event is fired the object is
already registered with its ObjectContext and has its ObjectId and
ObjectContext properties set.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PostAdd</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right after a new object is created inside
<code>ObjectContext.newObject()</code>. When this event is fired the object is
already registered with its ObjectContext and has its ObjectId and
ObjectContext properties set.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PrePersist</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right before a new object is committed, inside
<code>ObjectContext.commitChanges()</code> and
<code>ObjectContext.commitChangesToParent()</code> (and after
<code>"validateForInsert()"</code>).</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PrePersist</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right before a new object is committed, inside
<code>ObjectContext.commitChanges()</code> and
<code>ObjectContext.commitChangesToParent()</code> (and after
<code>"validateForInsert()"</code>).</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PreUpdate</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right before a modified object is committed, inside
<code>ObjectContext.commitChanges()</code> and
<code>ObjectContext.commitChangesToParent()</code> (and after
<code>"validateForUpdate()"</code>).</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PreUpdate</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right before a modified object is committed,
inside <code>ObjectContext.commitChanges()</code> and
<code>ObjectContext.commitChangesToParent()</code> (and after
<code>"validateForUpdate()"</code>).</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PreRemove</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right before an object is deleted, inside
<code>ObjectContext.deleteObjects()</code>. The event is also generated for
each object indirectly deleted as a result of CASCADE delete rule.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PreRemove</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right before an object is deleted, inside
<code>ObjectContext.deleteObjects()</code>. The event is also generated for
each object indirectly deleted as a result of CASCADE delete rule.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PostPersist</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right after a commit of a new object is done, inside
<code>ObjectContext.commitChanges()</code>.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PostPersist</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right after a commit of a new object is done,
inside <code>ObjectContext.commitChanges()</code>.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PostUpdate</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right after a commit of a modified object is done, inside
<code>ObjectContext.commitChanges()</code>.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PostUpdate</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right after a commit of a modified object is done,
inside <code>ObjectContext.commitChanges()</code>.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PostRemove</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">right after a commit of a deleted object is done, inside
<code>ObjectContext.commitChanges()</code>.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PostRemove</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">right after a commit of a deleted object is done,
inside <code>ObjectContext.commitChanges()</code>.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">PostLoad</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">PostLoad</p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="ulist">
<ul>
- <li><p>After an object is fetched inside
ObjectContext.performQuery().</p></li>
- <li><p>After an object is reverted inside
ObjectContext.rollbackChanges().</p></li>
- <li><p>Anytime a faulted object is resolved (i.e. if a relationship
is fetched).</p></li>
+ <li>
+ <p>After an object is fetched inside
ObjectContext.performQuery().</p></li>
+ <li>
+ <p>After an object is reverted inside
ObjectContext.rollbackChanges().</p></li>
+ <li>
+ <p>Anytime a faulted object is resolved (i.e. if a relationship is
fetched).</p></li>
</ul>
</div>
</div></td>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
b/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
index 9c091c1ee..128a1d971 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/maven_plugin.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Maven Plugin"
description: "Cayenne Guide 5.0, Maven Plugin"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 290
---
<div class="sect2">
<h3 id="maven_plugin"><a class="anchor" href="#maven_plugin"></a>5.1. Maven
Plugin</h3>
@@ -52,8 +54,10 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">map</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">map</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="paragraph">
@@ -86,89 +90,140 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">additionalMaps</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
directory that contains additional DataMap XML files that may be needed to
resolve cross-DataMap relationships for the the main DataMap, for which class
generation occurs.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">additionalMaps</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A directory that contains additional DataMap XML
files that may be needed to resolve cross-DataMap relationships for the the
main DataMap, for which class generation occurs.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">destDir</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Root destination directory for Java classes (ignoring their
package names). The default is "src/main/java".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">destDir</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Root destination directory for Java classes
(ignoring their package names). The default is "src/main/java".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">embeddableTemplate</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Location of a custom Velocity template file for Embeddable
class generation. If omitted, default template is used.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">embeddableTemplate</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Location of a custom Velocity template file for
Embeddable class generation. If omitted, default template is used.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">embeddableSuperTemplate</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Location of a custom Velocity template file for Embeddable
superclass generation. Ignored unless "makepairs" set to "true". If omitted,
default template is used.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">embeddableSuperTemplate</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Location of a custom Velocity template file for
Embeddable superclass generation. Ignored unless "makepairs" set to "true". If
omitted, default template is used.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">encoding</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Generated files encoding if different from the default on
current platform. Target encoding must be supported by the JVM running the
build. Standard encodings supported by Java on all platforms are US-ASCII,
ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE, UTF-16. See javadocs for
java.nio.charset.Charset for more information.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">encoding</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Generated files encoding if different from the
default on current platform. Target encoding must be supported by the JVM
running the build. Standard encodings supported by Java on all platforms are
US-ASCII, ISO-8859-1, UTF-8, UTF-16BE, UTF-16LE, UTF-16. See javadocs for
java.nio.charset.Charset for more information.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">excludeEntities</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
comma-separated list of ObjEntity patterns (expressed as a perl5 regex) to
exclude from template generation. By default none of the DataMap entities are
excluded.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">excludeEntities</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A comma-separated list of ObjEntity patterns
(expressed as a perl5 regex) to exclude from template generation. By default
none of the DataMap entities are excluded.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">includeEntities</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
comma-separated list of ObjEntity patterns (expressed as a perl5 regex) to
include from template generation. By default all DataMap entities are
included.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">includeEntities</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A comma-separated list of ObjEntity patterns
(expressed as a perl5 regex) to include from template generation. By default
all DataMap entities are included.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">makePairs</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">If
"true" (a recommended default), will generate subclass/superclass pairs, with
all generated code placed in superclass.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">makePairs</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">If "true" (a recommended default), will generate
subclass/superclass pairs, with all generated code placed in
superclass.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">mode</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Specifies class generator iteration target. There are three
possible values: "entity" (default), "datamap", "all". "entity" performs one
generator iteration for each included ObjEntity, applying either standard to
custom entity templates. "datamap" performs a single iteration, applying
DataMap templates. "All" is a combination of entity and datamap.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">mode</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Specifies class generator iteration target. There
are three possible values: "entity" (default), "datamap", "all". "entity"
performs one generator iteration for each included ObjEntity, applying either
standard to custom entity templates. "datamap" performs a single iteration,
applying DataMap templates. "All" is a combination of entity and
datamap.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">overwrite</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Only has effect when "makePairs" is set to "false". If
"overwrite" is "true", will overwrite older versions of generated
classes.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">overwrite</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Only has effect when "makePairs" is set to
"false". If "overwrite" is "true", will overwrite older versions of generated
classes.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">superPkg</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Java package name of all generated superclasses. If omitted,
each superclass will be placed in the subpackage of its subclass called "auto".
Doesn’t have any effect if either "makepairs" or "usePkgPath" are false (both
are true by default).</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">superPkg</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Java package name of all generated superclasses.
If omitted, each superclass will be placed in the subpackage of its subclass
called "auto". Doesn’t have any effect if either "makepairs" or "usePkgPath"
are false (both are true by default).</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">superTemplate</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Location of a custom Velocity template file for ObjEntity
superclass generation. Only has effect if "makepairs" set to "true". If
omitted, default template is used.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">superTemplate</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Location of a custom Velocity template file for
ObjEntity superclass generation. Only has effect if "makepairs" set to "true".
If omitted, default template is used.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">template</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Location of a custom Velocity template file for ObjEntity
class generation. If omitted, default template is used.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">template</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Location of a custom Velocity template file for
ObjEntity class generation. If omitted, default template is used.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">usePkgPath</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">If
set to "true" (default), a directory tree will be generated in "destDir"
corresponding to the class package structure, if set to "false", classes will
be generated in "destDir" ignoring their package.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">usePkgPath</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">If set to "true" (default), a directory tree will
be generated in "destDir" corresponding to the class package structure, if set
to "false", classes will be generated in "destDir" ignoring their
package.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">createPropertyNames</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">If
set to "true", will generate String Property names. Default is "false"</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">createPropertyNames</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">If set to "true", will generate String Property
names. Default is "false"</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">force</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">If
set to "true", will force run from maven/gradle.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">force</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">If set to "true", will force run from
maven/gradle.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">createPKProperties</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">If
set to "true", will generate PK attributes as Properties. Default is
"false".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">createPKProperties</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">If set to "true", will generate PK attributes as
Properties. Default is "false".</p></td>
</tr>
</tbody>
</table>
@@ -222,34 +277,54 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">map</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Yes</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">DataMap XML file which is the destination of the schema
import. Can be an existing file. If this file does not exist, it is created
when cdbimport is executed. E.g.
<code>${project.basedir}/src/main/resources/my.map.xml</code>. If "overwrite"
is true (the default), an existing DataMap will be used as a template for the
new imported DataMap, i.e. all its entities will be cleared and recreated, but
its common setti [...]
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">cayenneProject</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Project XML file which will be used. Can be an existing
file, in this case data map will be added to project if it’s not already there.
If this file does not exist, it is created when cdbimport is executed. E.g.
<code>${project.basedir}/src/main/resources/cayenne-project.xml</code>.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">adapter</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
Java class name implementing org.apache.cayenne.dba.DbAdapter. This attribute
is optional. If not specified, AutoAdapter is used, which will attempt to guess
the DB type.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">dataSource</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">XML</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Yes</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">An
object that contains Data Source parameters.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">dbimport</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">XML</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">An
object that contains detailed reverse engineering rules about what DB objects
should be processed. For full information about this parameter see <a
href="/docs/5.0/cayenne-guide/db-first-flow">DB-First Flow</a> chapter.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">map</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Yes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">DataMap XML file which is the destination of the
schema import. Can be an existing file. If this file does not exist, it is
created when cdbimport is executed. E.g.
<code>${project.basedir}/src/main/resources/my.map.xml</code>. If "overwrite"
is true (the default), an existing DataMap will be used as a template for the
new imported DataMap, i.e. all its entities will be cleared and recreated, but
its common settings, such as default Java package, will be prese [...]
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">cayenneProject</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Project XML file which will be used. Can be an
existing file, in this case data map will be added to project if it’s not
already there. If this file does not exist, it is created when cdbimport is
executed. E.g.
<code>${project.basedir}/src/main/resources/cayenne-project.xml</code>.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">adapter</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A Java class name implementing
org.apache.cayenne.dba.DbAdapter. This attribute is optional. If not specified,
AutoAdapter is used, which will attempt to guess the DB type.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">dataSource</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">XML</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Yes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">An object that contains Data Source
parameters.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">dbimport</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">XML</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">An object that contains detailed reverse
engineering rules about what DB objects should be processed. For full
information about this parameter see <a
href="/docs/5.0/cayenne-guide/db-first-flow">DB-First Flow</a> chapter.</p></td>
</tr>
</tbody>
</table>
@@ -273,28 +348,44 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">driver</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Yes</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
class of JDBC driver to use for the target database.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">url</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Yes</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">JDBC URL of a target database.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">username</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Database user name.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">password</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Database user password.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">driver</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Yes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A class of JDBC driver to use for the target
database.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">url</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Yes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">JDBC URL of a target database.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">username</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Database user name.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">password</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Database user password.</p></td>
</tr>
</tbody>
</table>
@@ -316,43 +407,66 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">defaultPackage</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
Java package that will be set as the imported DataMap default and a package of
all the persistent Java classes. This is a required attribute if the "map"
itself does not already contain a default package, as otherwise all the
persistent classes will be mapped with no package, and will not
compile.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">defaultPackage</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A Java package that will be set as the imported
DataMap default and a package of all the persistent Java classes. This is a
required attribute if the "map" itself does not already contain a default
package, as otherwise all the persistent classes will be mapped with no
package, and will not compile.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">forceDataMapCatalog</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Automatically tagging each DbEntity with the actual DB
catalog/schema (default behavior) may sometimes be undesirable. If this is the
case then setting <code>forceDataMapCatalog</code> to <code>true</code> will
set DbEntity catalog to one in the DataMap. Default value is
<code>false</code>.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">forceDataMapCatalog</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Automatically tagging each DbEntity with the
actual DB catalog/schema (default behavior) may sometimes be undesirable. If
this is the case then setting <code>forceDataMapCatalog</code> to
<code>true</code> will set DbEntity catalog to one in the DataMap. Default
value is <code>false</code>.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">forceDataMapSchema</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Automatically tagging each DbEntity with the actual DB
catalog/schema (default behavior) may sometimes be undesirable. If this is the
case then setting <code>forceDataMapSchema</code> to <code>true</code> will set
DbEntity schema to one in the DataMap. Default value is
<code>false</code>.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">forceDataMapSchema</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Automatically tagging each DbEntity with the
actual DB catalog/schema (default behavior) may sometimes be undesirable. If
this is the case then setting <code>forceDataMapSchema</code> to
<code>true</code> will set DbEntity schema to one in the DataMap. Default value
is <code>false</code>.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">meaningfulPkTables</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
comma-separated list of Perl5 patterns that defines which imported tables
should have their primary key columns mapped as ObjAttributes. "*" would
indicate all tables.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">meaningfulPkTables</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A comma-separated list of Perl5 patterns that
defines which imported tables should have their primary key columns mapped as
ObjAttributes. "*" would indicate all tables.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">namingStrategy</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">The naming strategy used for mapping database names to
object entity names. Default is
<code>o.a.c.dbsync.naming.DefaultObjectNameGenerator</code>.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">namingStrategy</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">The naming strategy used for mapping database
names to object entity names. Default is
<code>o.a.c.dbsync.naming.DefaultObjectNameGenerator</code>.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">skipPrimaryKeyLoading</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Whether to load primary keys. Default "false".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">skipPrimaryKeyLoading</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Whether to load primary keys. Default
"false".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">skipRelationshipsLoading</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Whether to load relationships. Default "false".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">skipRelationshipsLoading</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Whether to load relationships. Default
"false".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">stripFromTableNames</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">stripFromTableNames</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="paragraph">
@@ -373,18 +487,26 @@ cayenneNoToc: true
</div></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">usePrimitives</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Whether numeric and boolean data types should be mapped as
Java primitives or Java classes. Default is "true", i.e. primitives will be
used.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">usePrimitives</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Whether numeric and boolean data types should be
mapped as Java primitives or Java classes. Default is "true", i.e. primitives
will be used.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">useJava7Types</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Whether <em>DATE</em>, <em>TIME</em> and <em>TIMESTAMP</em>
data types should be mapped as <code>java.util.Date</code> or <code>java.time.*
classes</code>. Default is "false", i.e. <code>java.time.*</code> will be
used.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">useJava7Types</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Whether <em>DATE</em>, <em>TIME</em> and
<em>TIMESTAMP</em> data types should be mapped as <code>java.util.Date</code>
or <code>java.time.* classes</code>. Default is "false", i.e.
<code>java.time.*</code> will be used.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">tableTypes</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Collection<String></p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">tableTypes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Collection<String></p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="paragraph">
@@ -392,20 +514,29 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p>TABLE</p></li>
- <li><p>VIEW</p></li>
- <li><p>SYSTEM TABLE</p></li>
- <li><p>GLOBAL TEMPORARY</p></li>
- <li><p>LOCAL TEMPORARY</p></li>
- <li><p>ALIAS</p></li>
- <li><p>SYNONYM</p></li>
+ <li>
+ <p>TABLE</p></li>
+ <li>
+ <p>VIEW</p></li>
+ <li>
+ <p>SYSTEM TABLE</p></li>
+ <li>
+ <p>GLOBAL TEMPORARY</p></li>
+ <li>
+ <p>LOCAL TEMPORARY</p></li>
+ <li>
+ <p>ALIAS</p></li>
+ <li>
+ <p>SYNONYM</p></li>
</ul>
</div>
</div></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">filters configuration</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">XML</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">filters configuration</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">XML</p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="paragraph">
@@ -484,8 +615,10 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">map</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">map</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="paragraph">
@@ -499,9 +632,12 @@ cayenneNoToc: true
</div></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">dataSource</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">XML</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">An
object that contains Data Source parameters</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">dataSource</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">XML</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">An object that contains Data Source
parameters</p></td>
</tr>
</tbody>
</table>
@@ -525,28 +661,44 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">driver</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Yes</p></td>
- <td class="tableblock halign-left valign-middle"><p class="tableblock">A
class of JDBC driver to use for the target database.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">url</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Yes</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">JDBC URL of a target database.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">username</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Database user name.</p></td>
- </tr>
- <tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">password</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">No</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Database user password.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">driver</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Yes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">A class of JDBC driver to use for the target
database.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">url</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Yes</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">JDBC URL of a target database.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">username</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Database user name.</p></td>
+ </tr>
+ <tr>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">password</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">No</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Database user password.</p></td>
</tr>
</tbody>
</table>
@@ -568,34 +720,52 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">adapter</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">String</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Java class name implementing
org.apache.cayenne.dba.DbAdapter. While this attribute is optional (a generic
JdbcAdapter is used if not set), it is highly recommended to specify correct
target adapter.</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">adapter</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">String</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Java class name implementing
org.apache.cayenne.dba.DbAdapter. While this attribute is optional (a generic
JdbcAdapter is used if not set), it is highly recommended to specify correct
target adapter.</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">createFK</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Indicates whether cdbgen should create foreign key
constraints. Default is "true".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">createFK</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Indicates whether cdbgen should create foreign key
constraints. Default is "true".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">createPK</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Indicates whether cdbgen should create Cayenne-specific auto
PK objects. Default is "true".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">createPK</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Indicates whether cdbgen should create
Cayenne-specific auto PK objects. Default is "true".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">createTables</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Indicates whether cdbgen should create new tables. Default
is "true".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">createTables</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Indicates whether cdbgen should create new tables.
Default is "true".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">dropPK</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Indicates whether cdbgen should drop Cayenne primary key
support objects. Default is "false".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">dropPK</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Indicates whether cdbgen should drop Cayenne
primary key support objects. Default is "false".</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">dropTables</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">boolean</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">Indicates whether cdbgen should drop the tables before
attempting to create new ones. Default is "false".</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">dropTables</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">boolean</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">Indicates whether cdbgen should drop the tables
before attempting to create new ones. Default is "false".</p></td>
</tr>
</tbody>
</table>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne.html
b/src/main/site/content/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne.html
index b9a5fc374..f6cda4b75 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/object-relational-mapping-with-cayenne.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Object Relational Mapping with
Cayenne"
description: "Cayenne Guide 5.0, Object Relational Mapping with Cayenne"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 10
---
<div><h2>1. Object Relational Mapping with Cayenne</h2>
<ul>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/orderings.html
b/src/main/site/content/docs/5.0/cayenne-guide/orderings.html
index 0f303e45b..56df73a71 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/orderings.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/orderings.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Orderings"
description: "Cayenne Guide 5.0, Orderings"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 100
---
<div class="sect2">
<h3 id="orderings"><a class="anchor" href="#orderings"></a>2.5. Orderings</h3>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/performance-tuning.html
b/src/main/site/content/docs/5.0/cayenne-guide/performance-tuning.html
index 3e7fb2b99..e968c8990 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/performance-tuning.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/performance-tuning.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Performance Tuning"
description: "Cayenne Guide 5.0, Performance Tuning"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 130
---
<div class="sect2">
<h3 id="performance-tuning"><a class="anchor"
href="#performance-tuning"></a>2.8. Performance Tuning</h3>
@@ -112,8 +114,10 @@
PrefetchTreeNode.DISJOINT_BY_ID_PREFETCH_SEMANTICS</code></pre>
</div>
<div class="ulist">
<ul>
- <li><p>Include <em>all</em> columns from the root entity and every
prefetched entity.</p></li>
- <li><p>Label each prefetched entity columns as
"dbRelationship.column".</p></li>
+ <li>
+ <p>Include <em>all</em> columns from the root entity and every prefetched
entity.</p></li>
+ <li>
+ <p>Label each prefetched entity columns as
"dbRelationship.column".</p></li>
</ul>
</div>
<div class="paragraph">
@@ -333,11 +337,16 @@ context.performGenericQuery(refresh);</code></pre>
</div>
<div class="ulist">
<ul>
- <li><p>The performance of synchronization is (probably worse than) O(N)
where N is the number of peer ObjectContexts in the system. In a typical webapp
N can be quite large. Besides for any given context, due to locking on
synchronization, context own performance will depend not only on the queries
that it runs, but also on external events that it does not control. This is
unacceptable in most situations.</p></li>
- <li><p>Commit events are untargeted - even contexts that do not hold a
given updated object will receive the full event that they will have to
process.</p></li>
- <li><p>Clustering between JVMs doesn’t scale - apps with large volumes of
commits will quickly saturate the network with events, while most of those will
be thrown away on the receiving end as mentioned above.</p></li>
- <li><p>Some contexts may not want to be refreshed. A refresh in the middle
of an operation may lead to unpredictable results.</p></li>
- <li><p>Synchronization will interfere with optimistic locking.</p></li>
+ <li>
+ <p>The performance of synchronization is (probably worse than) O(N) where
N is the number of peer ObjectContexts in the system. In a typical webapp N can
be quite large. Besides for any given context, due to locking on
synchronization, context own performance will depend not only on the queries
that it runs, but also on external events that it does not control. This is
unacceptable in most situations.</p></li>
+ <li>
+ <p>Commit events are untargeted - even contexts that do not hold a given
updated object will receive the full event that they will have to
process.</p></li>
+ <li>
+ <p>Clustering between JVMs doesn’t scale - apps with large volumes of
commits will quickly saturate the network with events, while most of those will
be thrown away on the receiving end as mentioned above.</p></li>
+ <li>
+ <p>Some contexts may not want to be refreshed. A refresh in the middle of
an operation may lead to unpredictable results.</p></li>
+ <li>
+ <p>Synchronization will interfere with optimistic locking.</p></li>
</ul>
</div>
<div class="paragraph">
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/persistent-objects-objectcontext.html
b/src/main/site/content/docs/5.0/cayenne-guide/persistent-objects-objectcontext.html
index d5a05d67b..326c79c69 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/persistent-objects-objectcontext.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/persistent-objects-objectcontext.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Persistent Objects and
ObjectContext"
description: "Cayenne Guide 5.0, Persistent Objects and ObjectContext"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 80
---
<div class="sect2">
<h3 id="persistent-objects-objectcontext"><a class="anchor"
href="#persistent-objects-objectcontext"></a>2.3. Persistent Objects and
ObjectContext</h3>
@@ -64,28 +66,40 @@ cayenneNoToc: true
</colgroup>
<tbody>
<tr>
- <td class="tableblock halign-center valign-middle"><p
class="tableblock"><strong>TRANSIENT</strong></p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">The
object is not registered with an ObjectContext and will not be
persisted.</p></td>
+ <td class="tableblock halign-center valign-middle">
+ <p class="tableblock"><strong>TRANSIENT</strong></p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">The object is not registered with an ObjectContext
and will not be persisted.</p></td>
</tr>
<tr>
- <td class="tableblock halign-center valign-middle"><p
class="tableblock"><strong>NEW</strong></p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">The
object is freshly registered in an ObjectContext, but has not been saved to the
database yet and there is no matching database row.</p></td>
+ <td class="tableblock halign-center valign-middle">
+ <p class="tableblock"><strong>NEW</strong></p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">The object is freshly registered in an
ObjectContext, but has not been saved to the database yet and there is no
matching database row.</p></td>
</tr>
<tr>
- <td class="tableblock halign-center valign-middle"><p
class="tableblock"><strong>COMMITTED</strong></p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">The
object is registered in an ObjectContext, there is a row in the database
corresponding to this object, and the object state corresponds to the last
known state of the matching database row.</p></td>
+ <td class="tableblock halign-center valign-middle">
+ <p class="tableblock"><strong>COMMITTED</strong></p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">The object is registered in an ObjectContext,
there is a row in the database corresponding to this object, and the object
state corresponds to the last known state of the matching database row.</p></td>
</tr>
<tr>
- <td class="tableblock halign-center valign-middle"><p
class="tableblock"><strong>MODIFIED</strong></p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">The
object is registered in an ObjectContext, there is a row in the database
corresponding to this object, but the object in-memory state has diverged from
the last known state of the matching database row.</p></td>
+ <td class="tableblock halign-center valign-middle">
+ <p class="tableblock"><strong>MODIFIED</strong></p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">The object is registered in an ObjectContext,
there is a row in the database corresponding to this object, but the object
in-memory state has diverged from the last known state of the matching database
row.</p></td>
</tr>
<tr>
- <td class="tableblock halign-center valign-middle"><p
class="tableblock"><strong>HOLLOW</strong></p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">The
object is registered in an ObjectContext, there is a row in the database
corresponding to this object, but the object state is unknown. Whenever an
application tries to access a property of such object, Cayenne attempts reading
its values from the database and "inflate" the object, turning it to
COMMITTED.</p></td>
+ <td class="tableblock halign-center valign-middle">
+ <p class="tableblock"><strong>HOLLOW</strong></p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">The object is registered in an ObjectContext,
there is a row in the database corresponding to this object, but the object
state is unknown. Whenever an application tries to access a property of such
object, Cayenne attempts reading its values from the database and "inflate" the
object, turning it to COMMITTED.</p></td>
</tr>
<tr>
- <td class="tableblock halign-center valign-middle"><p
class="tableblock"><strong>DELETED</strong></p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">The
object is registered in an ObjectContext and has been marked for deletion
in-memory. The corresponding row in the database will get deleted upon
ObjectContext commit, and the object state will be turned into
TRANSIENT.</p></td>
+ <td class="tableblock halign-center valign-middle">
+ <p class="tableblock"><strong>DELETED</strong></p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">The object is registered in an ObjectContext and
has been marked for deletion in-memory. The corresponding row in the database
will get deleted upon ObjectContext commit, and the object state will be turned
into TRANSIENT.</p></td>
</tr>
</tbody>
</table>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/queries.html
b/src/main/site/content/docs/5.0/cayenne-guide/queries.html
index f2867c9f5..6dbd1158d 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/queries.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/queries.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Queries"
description: "Cayenne Guide 5.0, Queries"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 110
---
<div class="sect2">
<h3 id="queries"><a class="anchor" href="#queries"></a>2.6. Queries</h3>
@@ -303,9 +305,12 @@ SQLExec query = SQLExec.query("delete from $tableName")
</div>
<div class="ulist">
<ul>
- <li><p><code>value</code> - can either be a char constant or a variable
that is resolved from the query parameters. Note that the variable can be a
collection, that will be automatically expanded into a list of individual value
bindings. This is useful for instance to build IN conditions.</p></li>
- <li><p><code>jdbcType</code> - is a JDBC data type of the parameter as
defined in <code>java.sql.Types</code>.</p></li>
- <li><p><code>scale</code> - An optional scale of the numeric value. Same
as "scale" in PreparedStatement.</p></li>
+ <li>
+ <p><code>value</code> - can either be a char constant or a variable
that is resolved from the query parameters. Note that the variable can be a
collection, that will be automatically expanded into a list of individual value
bindings. This is useful for instance to build IN conditions.</p></li>
+ <li>
+ <p><code>jdbcType</code> - is a JDBC data type of the parameter as
defined in <code>java.sql.Types</code>.</p></li>
+ <li>
+ <p><code>scale</code> - An optional scale of the numeric value. Same as
"scale" in PreparedStatement.</p></li>
</ul>
</div>
<div class="paragraph">
@@ -422,9 +427,12 @@ SQLExec query = SQLExec.query("delete from $tableName")
</div>
<div class="ulist">
<ul>
- <li><p><code>value</code> - must be a variable that is resolved from the
query parameters to a Persistent or ObjectId.</p></li>
- <li><p><code>columns</code> - the names of the columns to generate in
the SQL.</p></li>
- <li><p><code>idColumn</code> - the names of the ID columns for a given
entity. Must match the order of "columns" to match against.</p></li>
+ <li>
+ <p><code>value</code> - must be a variable that is resolved from the
query parameters to a Persistent or ObjectId.</p></li>
+ <li>
+ <p><code>columns</code> - the names of the columns to generate in the
SQL.</p></li>
+ <li>
+ <p><code>idColumn</code> - the names of the ID columns for a given
entity. Must match the order of "columns" to match against.</p></li>
</ul>
</div>
<div class="paragraph">
@@ -518,10 +526,14 @@ SQLSelect select = SQLSelect.query(Painting.class, sql)
</div>
<div class="ulist">
<ul>
- <li><p><code>column</code> - the name of the column to render in SQL
SELECT clause.</p></li>
- <li><p><code>javaType</code> - a fully-qualified Java class name for a
given result column. For simplicity most common Java types used in JDBC can be
specified without a package. These include all numeric types, primitives,
String, SQL dates, BigDecimal and BigInteger. So <code>"#result('A'
'String')"</code>, <code>"#result('B' 'java.lang.String')"</code> and
<code>"#result('C' 'int')"</code> are all valid</p></li>
- <li><p><code>alias</code> - specifies both the SQL alias of the column
and the value key in the DataRow. If omitted, "column" value is used.</p></li>
- <li><p><code>dataRowKey</code> - needed if SQL 'alias' is not
appropriate as a DataRow key on the Cayenne side. One common case when this
happens is when a DataRow retrieved from a query is mapped using joint prefetch
keys (see below). In this case DataRow must use database path expressions for
joint column keys, and their format is incompatible with most databases alias
format.</p></li>
+ <li>
+ <p><code>column</code> - the name of the column to render in SQL SELECT
clause.</p></li>
+ <li>
+ <p><code>javaType</code> - a fully-qualified Java class name for a
given result column. For simplicity most common Java types used in JDBC can be
specified without a package. These include all numeric types, primitives,
String, SQL dates, BigDecimal and BigInteger. So <code>"#result('A'
'String')"</code>, <code>"#result('B' 'java.lang.String')"</code> and
<code>"#result('C' 'int')"</code> are all valid</p></li>
+ <li>
+ <p><code>alias</code> - specifies both the SQL alias of the column and
the value key in the DataRow. If omitted, "column" value is used.</p></li>
+ <li>
+ <p><code>dataRowKey</code> - needed if SQL 'alias' is not appropriate
as a DataRow key on the Cayenne side. One common case when this happens is when
a DataRow retrieved from a query is mapped using joint prefetch keys (see
below). In this case DataRow must use database path expressions for joint
column keys, and their format is incompatible with most databases alias
format.</p></li>
</ul>
</div>
<div class="paragraph">
@@ -747,8 +759,10 @@ List<String> names =
context.performQuery(query);</code></pre>
</div>
<div class="ulist">
<ul>
- <li><p>Null handling: SelectQuery would translate the expressions matching
NULL values to the corresponding "X IS NULL" or "X IS NOT NULL" SQL syntax.
EJBQLQuery on the other hand requires explicit "IS NULL" (or "IS NOT NULL")
syntax to be used, otherwise the generated SQL will look like "X = NULL" (or "X
<> NULL"), which will evaluate differently.</p></li>
- <li><p>Expression Parameters: SelectQuery uses "$" to denote named
parameters (e.g. "$myParam"), while EJBQL uses ":" (e.g. ":myParam"). Also
EJBQL supports positional parameters denoted by the question mark:
"?3".</p></li>
+ <li>
+ <p>Null handling: SelectQuery would translate the expressions matching
NULL values to the corresponding "X IS NULL" or "X IS NOT NULL" SQL syntax.
EJBQLQuery on the other hand requires explicit "IS NULL" (or "IS NOT NULL")
syntax to be used, otherwise the generated SQL will look like "X = NULL" (or "X
<> NULL"), which will evaluate differently.</p></li>
+ <li>
+ <p>Expression Parameters: SelectQuery uses "$" to denote named parameters
(e.g. "$myParam"), while EJBQL uses ":" (e.g. ":myParam"). Also EJBQL supports
positional parameters denoted by the question mark: "?3".</p></li>
</ul>
</div>
</div>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
index 6d1731777..5aca33f38 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/re-filtering.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Filtering"
description: "Cayenne Guide 5.0, Filtering"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 170
---
<div class="sect2">
<h3 id="re-filtering"><a class="anchor" href="#re-filtering"></a>3.2.
Filtering</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
index e793c2087..31e20968d 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/re-introduction.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Introduction"
description: "Cayenne Guide 5.0, Introduction"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 160
---
<div class="sect2">
<h3 id="re-introduction"><a class="anchor" href="#re-introduction"></a>3.1.
Introduction</h3>
@@ -30,10 +32,14 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p>A SQL migrations framework is used to bring a local DB to a certain
version. This is outside the scope of Cayenne and is done with a third-party
tool, such as Liquibase or Flyway.</p></li>
- <li><p>OR mapping model (Cayenne XML files) are synchronized with the
state of the database using <code>"cdbimport"</code> tool provided by
Cayenne.</p></li>
- <li><p>Object layer of the OR mapping model is customized to the developer
liking, usually via CayenneModeler. Subsequent runs of <code>"cdbimport"</code>
will not override any customizations that you make.</p></li>
- <li><p>Java classes are generated using <code>"cgen"</code> tool provided
by Cayenne.</p></li>
+ <li>
+ <p>A SQL migrations framework is used to bring a local DB to a certain
version. This is outside the scope of Cayenne and is done with a third-party
tool, such as Liquibase or Flyway.</p></li>
+ <li>
+ <p>OR mapping model (Cayenne XML files) are synchronized with the state
of the database using <code>"cdbimport"</code> tool provided by
Cayenne.</p></li>
+ <li>
+ <p>Object layer of the OR mapping model is customized to the developer
liking, usually via CayenneModeler. Subsequent runs of <code>"cdbimport"</code>
will not override any customizations that you make.</p></li>
+ <li>
+ <p>Java classes are generated using <code>"cgen"</code> tool provided by
Cayenne.</p></li>
</ul>
</div>
<div class="paragraph">
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
index f53a6dd92..0c0e2dc5e 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/re-modeler.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Reverse Engineering in Cayenne
Modeler"
description: "Cayenne Guide 5.0, Reverse Engineering in Cayenne Modeler"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 190
---
<div class="sect2">
<h3 id="re-modeler"><a class="anchor" href="#re-modeler"></a>3.4. Reverse
Engineering in Cayenne Modeler</h3>
@@ -44,22 +46,38 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p><strong>Add Catalog</strong></p></li>
- <li><p><strong>Add Schema</strong></p></li>
- <li><p><strong>Add Include Table</strong></p></li>
- <li><p><strong>Add Exclude Table</strong></p></li>
- <li><p><strong>Add Include Column</strong></p></li>
- <li><p><strong>Add Exclude Column</strong></p></li>
- <li><p><strong>Add Include Procedure</strong></p></li>
- <li><p><strong>Add Exclude Procedure</strong></p></li>
- <li><p><strong>Tables with Meaningful PK Pattern</strong>: Comma separated
list of RegExp’s for tables that you want to have meaningful primary keys. By
default no meaningful PKs are created.</p></li>
- <li><p><strong>Strip from table names</strong>: Regex that matches the
part of the table name that needs to be stripped off generating ObjEntity
name.</p></li>
- <li><p><strong>Skip relationships loading</strong>: Whether to load
relationships.</p></li>
- <li><p><strong>Skip primary key loading</strong>: Whether to load primary
keys.</p></li>
- <li><p><strong>Force datamap catalog</strong>: will set DbEntity catalog
to one in the DataMap.</p></li>
- <li><p><strong>Force datamap schema</strong>: will set DbEntity schema to
one in the DataMap.</p></li>
- <li><p><strong>Use Java primitive types</strong>: Use primitive types
(e.g. <strong>int</strong>) or Object types (e.g.
<strong>java.lang.Integer</strong>).</p></li>
- <li><p><strong>Use old java.util.Date type</strong>: Use
<strong>java.util.Date</strong> for all columns with
<strong>DATE/TIME/TIMESTAMP</strong> types. By default
<strong>java.time.</strong> types will be used.</p></li>
+ <li>
+ <p><strong>Add Catalog</strong></p></li>
+ <li>
+ <p><strong>Add Schema</strong></p></li>
+ <li>
+ <p><strong>Add Include Table</strong></p></li>
+ <li>
+ <p><strong>Add Exclude Table</strong></p></li>
+ <li>
+ <p><strong>Add Include Column</strong></p></li>
+ <li>
+ <p><strong>Add Exclude Column</strong></p></li>
+ <li>
+ <p><strong>Add Include Procedure</strong></p></li>
+ <li>
+ <p><strong>Add Exclude Procedure</strong></p></li>
+ <li>
+ <p><strong>Tables with Meaningful PK Pattern</strong>: Comma separated
list of RegExp’s for tables that you want to have meaningful primary keys. By
default no meaningful PKs are created.</p></li>
+ <li>
+ <p><strong>Strip from table names</strong>: Regex that matches the part
of the table name that needs to be stripped off generating ObjEntity
name.</p></li>
+ <li>
+ <p><strong>Skip relationships loading</strong>: Whether to load
relationships.</p></li>
+ <li>
+ <p><strong>Skip primary key loading</strong>: Whether to load primary
keys.</p></li>
+ <li>
+ <p><strong>Force datamap catalog</strong>: will set DbEntity catalog to
one in the DataMap.</p></li>
+ <li>
+ <p><strong>Force datamap schema</strong>: will set DbEntity schema to one
in the DataMap.</p></li>
+ <li>
+ <p><strong>Use Java primitive types</strong>: Use primitive types (e.g.
<strong>int</strong>) or Object types (e.g.
<strong>java.lang.Integer</strong>).</p></li>
+ <li>
+ <p><strong>Use old java.util.Date type</strong>: Use
<strong>java.util.Date</strong> for all columns with
<strong>DATE/TIME/TIMESTAMP</strong> types. By default
<strong>java.time.</strong> types will be used.</p></li>
</ul>
</div>
</div>
diff --git
a/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
b/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
index 3637c6cfd..d891e4569 100644
---
a/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
+++
b/src/main/site/content/docs/5.0/cayenne-guide/re-relationships-loading-control.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Other Settings"
description: "Cayenne Guide 5.0, Other Settings"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 180
---
<div class="sect2">
<h3 id="re-relationships-loading-control"><a class="anchor"
href="#re-relationships-loading-control"></a>3.3. Other Settings</h3>
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/setup.html
b/src/main/site/content/docs/5.0/cayenne-guide/setup.html
index 3ad5cfdff..eae4a211e 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/setup.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/setup.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Setup"
description: "Cayenne Guide 5.0, Setup"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 20
---
<div class="sect2">
<h3 id="setup"><a class="anchor" href="#setup"></a>1.1. Setup</h3>
@@ -27,7 +29,8 @@ cayenneNoToc: true
<h4 id="system-requirements"><a class="anchor"
href="#system-requirements"></a>1.1.1. System Requirements</h4>
<div class="ulist">
<ul>
- <li><p>Java: Cayenne runtime framework and CayenneModeler GUI tool are
written in 100% Java, and run on any Java-compatible platform. Minimal required
JDK version depends on the version of Cayenne you are using, as shown in the
following table:</p></li>
+ <li>
+ <p>Java: Cayenne runtime framework and CayenneModeler GUI tool are
written in 100% Java, and run on any Java-compatible platform. Minimal required
JDK version depends on the version of Cayenne you are using, as shown in the
following table:</p></li>
</ul>
</div>
<table id="versionHistory" class="tableblock frame-all grid-all stretch
table table-bordered">
@@ -48,46 +51,69 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">5.0</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
11 or newer</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Development</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">5.0</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 11 or newer</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Development</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">4.2</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
1.8 or newer</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Stable</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">4.2</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 1.8 or newer</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Stable</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">4.1</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
1.8 — Java 17</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Stable</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">4.1</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 1.8 — Java 17</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Stable</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">4.0</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
1.7 — Java 11</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Aging</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">4.0</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 1.7 — Java 11</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Aging</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock">3.0 /
3.1</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
1.5 — Java 1.8</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Legacy</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">3.0 / 3.1</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 1.5 — Java 1.8</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Legacy</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-top"><p class="tableblock">1.2 /
2.0</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
1.4</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Legacy</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">1.2 / 2.0</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 1.4</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Legacy</p></td>
</tr>
<tr>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">1.1</p></td>
- <td class="tableblock halign-left valign-top"><p class="tableblock">Java
1.3</p></td>
- <td class="tableblock halign-left valign-top"><p
class="tableblock">Legacy</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">1.1</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Java 1.3</p></td>
+ <td class="tableblock halign-left valign-top">
+ <p class="tableblock">Legacy</p></td>
</tr>
</tbody>
</table>
<div class="ulist">
<ul>
- <li><p>JDBC Driver: An appropriate DB-specific JDBC driver is needed to
access the database. It can be included in the application or used in web
container DataSource configuration.</p></li>
- <li><p>Third-party Libraries: Cayenne runtime framework has a minimal set
of required and a few more optional dependencies on third-party open source
packages. See <a
href="/docs/5.0/cayenne-guide/including-cayenne-in-project">Including Cayenne
in a Project</a> chapter for details.</p></li>
+ <li>
+ <p>JDBC Driver: An appropriate DB-specific JDBC driver is needed to
access the database. It can be included in the application or used in web
container DataSource configuration.</p></li>
+ <li>
+ <p>Third-party Libraries: Cayenne runtime framework has a minimal set of
required and a few more optional dependencies on third-party open source
packages. See <a
href="/docs/5.0/cayenne-guide/including-cayenne-in-project">Including Cayenne
in a Project</a> chapter for details.</p></li>
</ul>
</div>
</div>
@@ -98,9 +124,12 @@ cayenneNoToc: true
</div>
<div class="ulist">
<ul>
- <li><p>OS X distribution contains CayenneModeler.app at the root of the
distribution disk image.</p></li>
- <li><p>Windows distribution contains CayenneModeler.exe file in the bin
directory.</p></li>
- <li><p>Cross-platform distribution (targeting Linux, but as the name
implies, compatible with any OS) contains a runnable CayenneModeler.jar in the
bin directory. It can be executed either by double-clicking, or if the
environment is not configured to execute jars, by running from
command-line:</p></li>
+ <li>
+ <p>OS X distribution contains CayenneModeler.app at the root of the
distribution disk image.</p></li>
+ <li>
+ <p>Windows distribution contains CayenneModeler.exe file in the bin
directory.</p></li>
+ <li>
+ <p>Cross-platform distribution (targeting Linux, but as the name implies,
compatible with any OS) contains a runnable CayenneModeler.jar in the bin
directory. It can be executed either by double-clicking, or if the environment
is not configured to execute jars, by running from command-line:</p></li>
</ul>
</div>
<div class="listingblock">
@@ -150,8 +179,10 @@ cayenneNoToc: true
</thead>
<tbody>
<tr>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">modelFile</p></td>
- <td class="tableblock halign-left valign-middle"><p
class="tableblock">File</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">modelFile</p></td>
+ <td class="tableblock halign-left valign-middle">
+ <p class="tableblock">File</p></td>
<td class="tableblock halign-left valign-top">
<div class="content">
<div class="paragraph">
diff --git a/src/main/site/content/docs/5.0/cayenne-guide/starting-cayenne.html
b/src/main/site/content/docs/5.0/cayenne-guide/starting-cayenne.html
index 7421a0ade..50c4a4c59 100644
--- a/src/main/site/content/docs/5.0/cayenne-guide/starting-cayenne.html
+++ b/src/main/site/content/docs/5.0/cayenne-guide/starting-cayenne.html
@@ -20,6 +20,8 @@ title: "Cayenne Guide 5.0 · Starting Cayenne"
description: "Cayenne Guide 5.0, Starting Cayenne"
cayenneVersion: "5.0"
cayenneNoToc: true
+docId: cayenne-guide
+weight: 70
---
<div class="sect2">
<h3 id="starting-cayenne"><a class="anchor" href="#starting-cayenne"></a>2.2.
Starting Cayenne</h3>
@@ -83,12 +85,18 @@ CayenneRuntime runtime = CayenneRuntime.builder()
</div>
<div class="ulist">
<ul>
- <li><p>The order of projects matters during merge. If there are two
conflicting metadata objects belonging to two projects, an object from the last
project takes precedence over the object from the first one. This makes
possible to override pieces of metadata. This is also similar to how DI modules
are merged in Cayenne.</p></li>
- <li><p>Runtime DataDomain name is set to the name of the last project in
the list.</p></li>
- <li><p>Runtime DataDomain properties are the same as the properties of the
last project in the list. I.e. properties are not merged to avoid invalid
combinations and unexpected runtime behavior.</p></li>
- <li><p>If there are two or more DataMaps with the same name, only one
DataMap is used in the merged project, the rest are discarded. Same precedence
rules apply - DataMap from the project with the highest index in the project
list overrides all other DataMaps with the same name.</p></li>
- <li><p>If there are two or more DataNodes with the same name, only one
DataNode is used in the merged project, the rest are discarded. DataNode coming
from project with the highest index in the project list is chosen per
precedence rule above.</p></li>
- <li><p>There is a notion of "default" DataNode. After the merge if any
DataMaps are not explicitly linked to DataNodes, their queries will be executed
via a default DataNode. This makes it possible to build mapping "libraries"
that are only associated with a specific database in runtime. If there’s only
one DataNode in the merged project, it will be automatically chosen as default.
A possible way to explicitly designate a specific node as default is to
override <code>DataDomainProvid [...]
+ <li>
+ <p>The order of projects matters during merge. If there are two
conflicting metadata objects belonging to two projects, an object from the last
project takes precedence over the object from the first one. This makes
possible to override pieces of metadata. This is also similar to how DI modules
are merged in Cayenne.</p></li>
+ <li>
+ <p>Runtime DataDomain name is set to the name of the last project in the
list.</p></li>
+ <li>
+ <p>Runtime DataDomain properties are the same as the properties of the
last project in the list. I.e. properties are not merged to avoid invalid
combinations and unexpected runtime behavior.</p></li>
+ <li>
+ <p>If there are two or more DataMaps with the same name, only one DataMap
is used in the merged project, the rest are discarded. Same precedence rules
apply - DataMap from the project with the highest index in the project list
overrides all other DataMaps with the same name.</p></li>
+ <li>
+ <p>If there are two or more DataNodes with the same name, only one
DataNode is used in the merged project, the rest are discarded. DataNode coming
from project with the highest index in the project list is chosen per
precedence rule above.</p></li>
+ <li>
+ <p>There is a notion of "default" DataNode. After the merge if any
DataMaps are not explicitly linked to DataNodes, their queries will be executed
via a default DataNode. This makes it possible to build mapping "libraries"
that are only associated with a specific database in runtime. If there’s only
one DataNode in the merged project, it will be automatically chosen as default.
A possible way to explicitly designate a specific node as default is to
override <code>DataDomainProvider. [...]
</ul>
</div>
</div>
diff --git a/src/main/site/layouts/docs/single.html
b/src/main/site/layouts/docs/single.html
index 678ec9cd4..82806a623 100644
--- a/src/main/site/layouts/docs/single.html
+++ b/src/main/site/layouts/docs/single.html
@@ -2,6 +2,19 @@
{{ partial "header.html" . }}
{{ partial "docs_header.html" . }}
+{{ $curPage := .Page }}
+{{ $curPageIdx := -1 }}
+
+{{ $docPages := where $.Site.Pages "Params.cayenneversion"
$curPage.Params.cayenneVersion }}
+{{ $docPages = sort (where $docPages "Params.docid" $curPage.Params.docId)
"Weight" "asc" }}
+{{ range $i, $docPage := $docPages }}
+ {{ if $curPage.Eq $docPage }}
+ {{ $curPageIdx = $i }}
+ {{ end }}
+{{ end }}
+
+{{ $nextPage := index $docPages (add $curPageIdx 1) }}
+
<article>
<header>
{{- if not (eq .Params.cayenneNoToc true) }}
@@ -11,6 +24,22 @@
<section>
{{ .Content }}
</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">
+ {{ with $nextPage }}
+ <a class="btn btn-link" href='{{ .Permalink |
relURL }}'>
+ <span class="d-block d-md-none
text-muted">Next: </span>
+ Next: {{ .Title }}
+ <i class="small fa fa-chevron-right
ml-3l2 d-none d-md-inline"></i>
+ </a>
+ {{ end }}
+ </div>
+ </div>
+ </footer>
</article>
{{/* .Scratch.Set "pix" "docs" */}}
