Skip to content

Commit d11e49c

Browse files
committed
add some links to Hibernate ORM docs
1 parent 55350d4 commit d11e49c

File tree

1 file changed

+22
-4
lines changed

1 file changed

+22
-4
lines changed

documentation/src/main/asciidoc/reference/introduction.adoc

+22-4
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,8 @@ There's an example {build}[Gradle build] included in the example program.
7878
=== Configuration
7979

8080
:xml: https://github.com/hibernate/hibernate-reactive/blob/master/example/src/main/resources/META-INF/persistence.xml
81+
:configuration-properties: https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#configurations
82+
8183

8284
Hibernate Reactive is configured via the standard JPA `persistence.xml`
8385
document which must be placed, as usual, in the `/META-INF` directory.
@@ -92,9 +94,11 @@ The only configuration specific to Hibernate Reactive is the persistence
9294

9395
Otherwise, configuration is almost completely transparent. Configure
9496
Hibernate exactly as you usually would, noting that most configuration
95-
properties related to JDBC or JTA aren't relevant in the context of
96-
Hibernate Reactive.
97+
properties directly related to JDBC or JTA aren't relevant in the context
98+
of Hibernate Reactive.
9799

100+
A full list of configuration properties recognized by Hibernate may be
101+
found in the {configuration-properties}[documentation for Hibernate ORM].
98102
Configuration properties of particular interest include:
99103

100104
- `javax.persistence.jdbc.url`, the JDBC URL of your database,
@@ -149,6 +153,8 @@ TIP: But for now, just leave these three settings alone.
149153

150154
=== Enabling the second-level cache
151155

156+
:second-level-cache: https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#caching
157+
152158
Hibernate Reactive supports second-level cache implementations that
153159
perform no blocking I/O.
154160

@@ -180,6 +186,9 @@ TIP: Don't forget that you need to explicitly mark each entity that will
180186
be stored in the second-level cache with the `@Cache` annotation from
181187
`org.hibernate.annotations`.
182188

189+
You can find much more information about the second-level cache in the
190+
{second-level-cache}[documentation for Hibernate ORM].
191+
183192
== Writing the Java code
184193

185194
With that out of the way, we're all set to write some Java code!
@@ -218,6 +227,8 @@ of framework code.
218227

219228
=== Mapping entity classes
220229

230+
:mapping-annotations: https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#annotations
231+
221232
We won't have much to say about the entity classes here, simply because
222233
the principles behind mapping entity classes in Hibernate Reactive,
223234
along with the actual mapping annotations you'll use, are all identical
@@ -253,8 +264,10 @@ You're quite free to mix and match:
253264
`javax.persistence` with
254265
- the advanced mapping annotations in `org.hibernate.annotations`.
255266

256-
Most mapping annotations are already supported in Hibernate Reactive,
257-
though there are still a handful of limitations at this time.
267+
A full list of object/relational mapping annotations may be found in the
268+
{mapping-annotations}[documentation for Hibernate ORM]. Most mapping
269+
annotations are already supported in Hibernate Reactive, though there are
270+
still a handful of limitations at this time.
258271

259272
=== Identifier generation
260273

@@ -525,6 +538,8 @@ have very specific requirements.
525538

526539
=== A reminder about performance
527540

541+
:association-fetching: https://docs.jboss.org/hibernate/orm/5.4/userguide/html_single/Hibernate_User_Guide.html#fetching
542+
528543
As always, achieving high performance in ORM means minimizing the number
529544
of round trips to the database. This goal should be uppermost in your
530545
mind whenever you're writing data access code with Hibernate. The most
@@ -548,6 +563,9 @@ second-level cache, batch fetching, subselect fetching, bulk update and
548563
delete queries, and direct execution of native SQL are all things that
549564
can help reduce the number of queries sent to the database.
550565

566+
You can find much more information about association fetching in the
567+
{association-fetching}[documentation for Hibernate ORM].
568+
551569
=== Transactions
552570

553571
The `withTransaction()` method performs work within the scope of a database

0 commit comments

Comments
 (0)