Spring/spring-boot-data-geode
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Apply consistent styling to quoted text.

Browse Source 
Resolves gh-109.
This commit is contained in:
John Blum
2021-07-19 17:41:43 -07:00
parent e981422b68
commit 110091de3b
5 changed files with 18 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.adoc
View File

@@ -210,7 +210,7 @@ annotating the `User` class with the SDG `@Region` mapping annotation along with
to be the ID of `User` instances.
By declaring the `@Region` mapping annotation we are stating that instances of `User` will be stored in an {geode-name}
cache `Region` named "Users". The _Spring Data_ `@Id` annotation serves to declare the identifier for a `User` object
cache `Region` named "`Users`". The _Spring Data_ `@Id` annotation serves to declare the identifier for a `User` object
stored in {geode-name}. This is not unlike JPA's `@javax.persistence.Table` and `@javax.persistence.Id` mapping
annotations.
@@ -298,11 +298,11 @@ The `UserApplication` class is annotated with `@SpringBootApplication` making it
With SBDG on the classpath, this effectively makes our application an {geode-name} application as well. SBDG will
_auto-configure_ an {geode-name} `ClientCache` instance by default when SBDG is on the application classpath.
With the SDG `@Region` mapping annotation, we declared that instances of `User` will be stored in the "Users" `Region`.
However, we have not yet created a "Users" `Region`. This is where the `@EnableEntityDefinedRegions` annotation comes
With the SDG `@Region` mapping annotation, we declared that instances of `User` will be stored in the "`Users`" `Region`.
However, we have not yet created a "`Users`" `Region`. This is where the `@EnableEntityDefinedRegions` annotation comes
in handy. Like JPA/Hibernate's ability to create database tables from our `@Entity` declared classes, SDG's
`@EnableEntityDefineRegions` annotation scans the classpath for application entity classes (e.g. `User`)
and detects any classes annotated with `@Region` in order to create the "named" `Region` required by the application
and detects any classes annotated with `@Region` in order to create the named `Region` required by the application
to persist data. The `basePackageClasses` attribute is a type-safe way to pinpoint the scan.
While useful and convenient during development, `@EnableEntityDefinedRegions` was not made into an _auto-configuration_

4
spring-geode-docs/src/docs/asciidoc/_includes/actuator.adoc
View File

@@ -213,7 +213,7 @@ that were indexed. For all other `Indexes`, returns `*`.
|=====================================================================================================================
Additionally, when statistics are enabled (for example, when you use `@EnableStatistics` --
see {spring-data-geode-docs-html}/#bootstrap-annotation-config-statistics["`Configuring Statistics`"] for more details),
see {spring-data-geode-docs-html}/#bootstrap-annotation-config-statistics[Configuring Statistics] for more details),
the following metadata is available:
.Index Statistic Details
@@ -284,7 +284,7 @@ instance (that is, the application is a cache client), which is the default.
client applications receive automatic notification about events that satisfy some criteria. That criteria can be easily
expressed by using the predicate of an OQL query (for example, `SELECT * FROM /Customers c WHERE c.age > 21`).
When data is inserted or updated and the data matches the criteria specified in the OQL query predicate
("data of interests"), an event is sent to the registered client.
(data of interests), an event is sent to the registered client.
The following details are covered for CQs by name:

2
spring-geode-docs/src/docs/asciidoc/_includes/configuration-declarative.adoc
View File

@@ -56,7 +56,7 @@ In subsequent sections, we also cover which annotations are added by SBDG.
[[geode-configuration-declarative-auto-configuration]]
=== Auto-configuration
We explained auto-configuration in detail in the "<<geode-configuration-auto,Auto-configuration>>" chapter.
We explained auto-configuration in detail in the <<geode-configuration-auto,Auto-configuration>> chapter.
[[geode-configuration-declarative-annotations]]
=== Annotations Not Covered by Auto-configuration

11
spring-geode-docs/src/docs/asciidoc/_includes/docker.adoc
View File

@@ -300,16 +300,17 @@ We additionally annotate the main class with SBDG's `@EnableClusterAware` annota
the {geode-name} cluster that runs in the Docker container and to push cluster configuration metadata from
the application to the cluster as required by the application.
Specifically, the application requires that a Region called "Customers", as defined by the `@Region` mapping annotation
on the `Customer` application domain model class, exists on the servers in the cluster, to store `Customer` data.
Specifically, the application requires that a Region called "`Customers`", as defined by the `@Region` mapping
annotation on the `Customer` application domain model class, exists on the servers in the cluster, to store `Customer`
data.
We use the SDG `@EnableEntityDefinedRegions` annotation to define the matching client `PROXY` "Customers" Region.
We use the SDG `@EnableEntityDefinedRegions` annotation to define the matching client `PROXY` "`Customers`" Region.
Optionally, we have also annotated our main class with SBDG's `@UseMemberName` annotation to give the `ClientCache`
a name, which we assert in the `assertClientCacheAndConfigureMappingPdxSerializer(:ClientCache)` method.
The primary work performed by this application is done in the Spring Boot `ApplicationRunner` bean definition. We create
a `Customer` instance (`Jon Doe`), save it to the "Customers" Region that is managed by the server in the cluster,
a `Customer` instance (`Jon Doe`), save it to the "`Customers`" Region that is managed by the server in the cluster,
and then query for `Jon Doe` using OQL, asserting that the result is equal to what we expect.
We log the output from the application's operations to see the application in action.
@@ -372,7 +373,7 @@ Region | size | 1
Our `/Customers` Region contains a value (`Jon Doe`), and we can verify this by running the following OQL Query
with Gfsh:
.Query the "/Customers" Region
.Query the `/Customers` Region
====
[source,text]
----

10
spring-geode-docs/src/docs/asciidoc/index.adoc
View File

@@ -163,10 +163,10 @@ of {apache-geode-name} applications in a Spring context, using Spring's powerful
programming model. This part of the story was greatly enhanced in Spring Data Kay,
with the {spring-data-geode-docs-html}/#bootstrap-annotation-config[Annotation-based configuration model].
Though this new configuration approach uses annotations and provides sensible defaults, its use is also very explicit
and assumes nothing. If any part of the configuration is ambiguous, SDG will fail fast. SDG gives you "`_choice_`",
so you still must tell SDG what you want.
and assumes nothing. If any part of the configuration is ambiguous, SDG will fail fast. SDG gives you choice, so you
still must tell SDG what you want.
Next, we venture into Spring Boot and all of its wonderfully expressive and highly opinionated "`_convention over configuration_`"
Next, we venture into Spring Boot and all of its wonderfully expressive and highly opinionated "`convention over configuration`"
approach for getting the most out of your Spring {apache-geode-name} applications in the easiest, quickest, and most
reliable way possible. We accomplish this by combining Spring Data for {apache-geode-name}'s {spring-data-geode-docs-html}/#bootstrap-annotation-config[annotation-based configuration]
with Spring Boot's {spring-boot-docs-html}/#using-boot-auto-configuration[auto-configuration] to get you up and running
@@ -302,7 +302,7 @@ For example, SBDG `1.4.0` is based on Spring Boot `2.4.0`. SBDG `1.3.5.RELEASE`
and so on. It is important that the versions align.
TIP: All of these concerns are handled for you by going to https://start.spring.io[start.spring.io]
and adding the "_Spring for {apache-geode-name}_" dependency to a project. For convenience, you can click
and adding the "`_Spring for {apache-geode-name}_`" dependency to a project. For convenience, you can click
this https://start.spring.io/#!platformVersion={spring-boot-version}&dependencies=geode[link] to get started.
[[gradle-dependency-management]]
@@ -376,7 +376,7 @@ such as `SNAPSHOT`, `M#`, `RC#`, or `RELEASE`, if applicable). For example, SBDG
SBDG `1.3.5.RELEASE` is based on Spring Boot `2.3.5.RELEASE`, and so on. It is important that the versions align.
TIP: All of these concerns are handled for you by going to https://start.spring.io[start.spring.io]
and adding the "_Spring for {apache-geode-name}_" dependency to a project. For convenience, you can click
and adding the "`_Spring for {apache-geode-name}_`" dependency to a project. For convenience, you can click
this https://start.spring.io/#!platformVersion={spring-boot-version}&dependencies=geode[link] to get started.
ifeval::["{version-snapshot}" == "true"]