You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cayenne.apache.org by nt...@apache.org on 2018/07/16 13:59:28 UTC
cayenne git commit: Update documentation
Repository: cayenne
Updated Branches:
refs/heads/STABLE-4.0 1fb319c55 -> ac446f9ac
Update documentation
Project: http://git-wip-us.apache.org/repos/asf/cayenne/repo
Commit: http://git-wip-us.apache.org/repos/asf/cayenne/commit/ac446f9a
Tree: http://git-wip-us.apache.org/repos/asf/cayenne/tree/ac446f9a
Diff: http://git-wip-us.apache.org/repos/asf/cayenne/diff/ac446f9a
Branch: refs/heads/STABLE-4.0
Commit: ac446f9ac29e2e598a1722122cb247b6c3968acb
Parents: 1fb319c
Author: Nikita Timofeev <st...@gmail.com>
Authored: Mon Jul 16 16:59:19 2018 +0300
Committer: Nikita Timofeev <st...@gmail.com>
Committed: Mon Jul 16 16:59:19 2018 +0300
----------------------------------------------------------------------
.../_cayenne-guide/configurationProperties.adoc | 27 ++++++++++++++++++++
.../asciidoc/_cayenne-guide/part2/tuning.adoc | 2 +-
.../_cayenne-guide/serviceCollections.adoc | 7 +++--
3 files changed, 31 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/cayenne/blob/ac446f9a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/configurationProperties.adoc
----------------------------------------------------------------------
diff --git a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/configurationProperties.adoc b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/configurationProperties.adoc
index 2bedc73..bedb78b 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/configurationProperties.adoc
+++ b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/configurationProperties.adoc
@@ -48,12 +48,29 @@ Note that the property names below are defined as constants in `org.apache.cayen
overrides DataSource info just for this domain/node. Otherwise the override is applied to all domains/nodes in the system
** Default value: none, project DataNode configuration is used
+* `cayenne.jdbc.max_wait`
+ 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.
+ ** Default value: 20 seconds
+
+* `cayenne.jdbc.validation_query`
+ defines a SQL string that returns some result. It will be used to
+ validate connections in the pool.
+ ** Default value: none
+
* `cayenne.querycache.size`
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.
** Possible values: any positive int value
** Default value: 2000
+* `cayenne.DataRowStore.snapshot.size`
+ defines snapshot cache max size
+ ** Possible values: any positive int
+ ** Default value: 10000
+
* `cayenne.server.contexts_sync_strategy`
defines whether peer ObjectContexts should receive snapshot events after commits from other contexts. If true (_default_),
the contexts would automatically synchronize their state with peers.
@@ -77,6 +94,16 @@ Note that the property names below are defined as constants in `org.apache.cayen
** Possible values: true, false
** Default value: false
+* `cayenne.server.query_execution_time_logging_threshold`
+ defines the minimum number of milliseconds a query must run before it is logged.
+ A value less than or equal to zero disables logging.
+ ** Default value: 0
+
+* `cayenne.server.domain.name`
+ defines an optional name of the runtime DataDomain.
+ If not specified, the name is inferred from the configuration name.
+ ** Default value: none
+
* `cayenne.rop.service_url`
defines the URL of the ROP server
** Default value: none
http://git-wip-us.apache.org/repos/asf/cayenne/blob/ac446f9a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part2/tuning.adoc
----------------------------------------------------------------------
diff --git a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part2/tuning.adoc b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part2/tuning.adoc
index ea0fea2..6237c54 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part2/tuning.adoc
+++ b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/part2/tuning.adoc
@@ -290,7 +290,7 @@ Those are arbitrary names that allow to categorize queries for the purpose of se
The above API is enough for the caching to work, but by default your cache is an unmanaged LRU map. You can't control its size,
expiration policies, etc. For the managed cache, you will need to explicitly use one of the more advanced cache providers.
-Use can use <<ext-cayenne-jcache,JCache integration module>> to enable any of JCache API compatible caching providers.
+Use can use <<ext-jcache,JCache integration module>> to enable any of JCache API compatible caching providers.
Often "passive" cache expiration policies used by caching providers are not sufficient, and the users want real-time cache invalidation when the data changes.
So in addition to those policies, the app can invalidate individual cache groups explicitly with `RefreshQuery`:
http://git-wip-us.apache.org/repos/asf/cayenne/blob/ac446f9a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/serviceCollections.adoc
----------------------------------------------------------------------
diff --git a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/serviceCollections.adoc b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/serviceCollections.adoc
index d234723..6678865 100644
--- a/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/serviceCollections.adoc
+++ b/docs/asciidoc/cayenne-guide/src/docs/asciidoc/_cayenne-guide/serviceCollections.adoc
@@ -34,27 +34,26 @@ Note that the collection keys below are defined as constants in `org.apache.caye
.^|`List<DataChannelFilter>`
.^|Stores DataDomain filters.
+.^|`cayenne.server.domain_listeners`
+.^|`List<Object>`
+.^|Stores DataDomain listeners.
.^|`cayenne.server.project_locations`
.^|`List<String>`
.^|Stores locations of the one of more project configuration files.
-
.^|`cayenne.server.default_types`
.^|`List<ExtendedType>`
.^|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 `"cayenne.server.user_types"`).
-
.^|`cayenne.server.user_types`
.^|`List<ExtendedType>`
.^|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.
-
.^|`cayenne.server.type_factories`
.^|`List<ExtendedTypeFactory>`
.^|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.
-
.^|`cayenne.server.rop_event_bridge_properties`
.^|`Map<String, String>`
.^|Stores event bridge properties passed to the ROP client on bootstrap. This means that the map is configured by server DI, and passed to the client via the wire. The properties in this map are specific to EventBridgeFactory implementation (e.g JMS or XMPP connection prameters). One common property is `"cayenne.server.rop_event_bridge_factory"` that defines the type of the factory.