From db1ed28a10d07a898089e6fd98fd9f35df0d9cdc Mon Sep 17 00:00:00 2001 From: Tony Date: Mon, 16 Sep 2019 13:23:58 -0500 Subject: [PATCH] NIMBUS-314: @Repo and cache documentation --- .../pages/config-annotations/pages/core/pages/repo.adoc | 6 ++++-- .../pages/configuration/pages/data-source/default.adoc | 6 ++++-- .../configuration/pages/data-source/pages/caching.adoc | 9 +++++++++ 3 files changed, 17 insertions(+), 4 deletions(-) create mode 100644 src/pages/fundamentals/pages/configuration/pages/data-source/pages/caching.adoc diff --git a/src/pages/fundamentals/pages/appendix/pages/config-annotations/pages/core/pages/repo.adoc b/src/pages/fundamentals/pages/appendix/pages/config-annotations/pages/core/pages/repo.adoc index b6c2ec7..7e8e184 100644 --- a/src/pages/fundamentals/pages/appendix/pages/config-annotations/pages/core/pages/repo.adoc +++ b/src/pages/fundamentals/pages/appendix/pages/config-annotations/pages/core/pages/repo.adoc @@ -1,7 +1,7 @@ [[core-config-annotation-repo]] [discrete] = Repo -@Repo is used to determine where the data will be persisted. It is always used along with @Domain. +`@Repo` is used to determine where the data will be persisted. It is always used along with <>. [[core-config-annotation-rep_mongodb]] == rep_mongodb @@ -17,4 +17,6 @@ The following example shows how data is persisted/ retrieved using MongoDB as a @Getter @Setter public class CMAssessment extends IdString { } ----- \ No newline at end of file +---- + +See <> for more information on configuring `@Repo`. \ No newline at end of file diff --git a/src/pages/fundamentals/pages/configuration/pages/data-source/default.adoc b/src/pages/fundamentals/pages/configuration/pages/data-source/default.adoc index ca26403..90fa8fb 100644 --- a/src/pages/fundamentals/pages/configuration/pages/data-source/default.adoc +++ b/src/pages/fundamentals/pages/configuration/pages/data-source/default.adoc @@ -1,6 +1,6 @@ [[configuration-data-source]] = Configuring data source connections -TODO +The <> annotation can be used to point a given domain entity definition to a configured `DataSource` connection. The sections that follow will explain the details of how to configure a particular `DataSource` and the capabilities of using <>. // include::pages/rdbms.adoc[leveloffset=+1] @@ -8,4 +8,6 @@ include::pages/mongodb.adoc[leveloffset=+1] include::pages/webservice.adoc[leveloffset=+1] -include::pages/custom.adoc[leveloffset=+1] \ No newline at end of file +include::pages/custom.adoc[leveloffset=+1] + +include::pages/caching.adoc[leveloffset=+1] \ No newline at end of file diff --git a/src/pages/fundamentals/pages/configuration/pages/data-source/pages/caching.adoc b/src/pages/fundamentals/pages/configuration/pages/data-source/pages/caching.adoc new file mode 100644 index 0000000..060c8c7 --- /dev/null +++ b/src/pages/fundamentals/pages/configuration/pages/data-source/pages/caching.adoc @@ -0,0 +1,9 @@ +[[configuration-data-source-caching]] += Caching +Nimbus offers cache support at the domain entity level that can be configured using <>. + +Nimbus currently the following caching mechanisms: + +[horizontal] +`rep_none` :: the domain entity will not participate in caching. +`rep_device` :: the domain entity will be cached within the session cache. \ No newline at end of file