easier links to user guide

as suggested by Steve
This commit is contained in:
Gavin 2023-05-17 20:14:44 +02:00 committed by Christian Beikov
parent 66c788797c
commit de32b73e4e
6 changed files with 13 additions and 10 deletions

View File

@ -404,7 +404,7 @@ Point event =
.getSingleResult();
----
:matrix: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#spatial-configuration-dialect-features
:matrix: {userGuideBase}#spatial-configuration-dialect-features
Here, `within()` is one of the functions for testing spatial relations defined by the OpenGIS specification.
Other such functions include `touches()`, `intersects()`, `distance()`, `boundary()`, etc.

View File

@ -77,7 +77,7 @@ Where `{version}` is the latest version of the JDBC driver for your databse.
=== Optional dependencies
:slf4j: http://www.slf4j.org/
:enhancer: https://docs.jboss.org/hibernate/orm/5.4/topical/html_single/bytecode/BytecodeEnhancement.html
:enhancer: {versionDocBase}/topical/html_single/bytecode/BytecodeEnhancement.html
:agroal: https://agroal.github.io
:jackson: https://github.com/FasterXML/jackson
:yasson: https://projects.eclipse.org/projects/ee4j.yasson
@ -210,8 +210,8 @@ SessionFactory sessionFactory = new Configuration()
The `Configuration` class has survived almost unchanged since the very earliest (pre-1.0) versions of Hibernate, and so it doesn't look particularly modern.
On the other hand, it's very easy to use, and exposes some options that `persistence.xml` doesn't support.
:native-bootstrap: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#bootstrap-native
:boot: https://docs.jboss.org/hibernate/orm/6.2/javadocs/org/hibernate/boot/package-summary.html
:native-bootstrap: {userGuideBase}#bootstrap-native
:boot: {versionDocBase}/javadocs/org/hibernate/boot/package-summary.html
.Advanced configuration options
****

View File

@ -3,6 +3,9 @@
:icons: font
:doctype: book
:pdf-fontsdir: fonts
:docsBase: https://docs.jboss.org/hibernate/orm
:versionDocBase: {docsBase}/6.3
:userGuideBase: {versionDocBase}/userguide/html_single/Hibernate_User_Guide.html
= An introduction to Hibernate 6
Gavin King and the Hibernate team

View File

@ -381,7 +381,7 @@ It's not necessary to dirty-check on entity instance in read-only mode.
[[queries]]
=== Queries
:hql: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#query-language
:hql: {userGuideBase}#query-language
Hibernate features three complementary ways to write queries:
@ -392,7 +392,7 @@ Hibernate features three complementary ways to write queries:
[[hql-queries]]
=== HQL queries
:hql: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#query-language
:hql: {userGuideBase}#query-language
A full discussion of the query language would require just as much text as the rest of this Introduction.
Fortunately, HQL is already described in exhaustive (and exhausting) detail in the {hql}[User Guide].
@ -570,7 +570,7 @@ query.select(book).where(where)
----
:generator: https://hibernate.org/orm/tooling/
:generator-guide: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#tooling-modelgen
:generator-guide: {userGuideBase}#tooling-modelgen
Here, the classes `Book_` and `Author_` are classes generated by Hibernate's {generator}[JPA Metamodel Generator], which is documented in the {generator-guide}[User Guide].

View File

@ -1,7 +1,7 @@
[[preface]]
== Preface
:user-guide: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html
:user-guide: {userGuideBase}
Hibernate 6 is a major redesign of the world's most popular and feature-rich ORM solution.
The redesign has touched almost every subsystem of Hibernate, including the APIs, mapping annotations, and the query language.

View File

@ -97,7 +97,7 @@ Even better than DML statement batching is the use of HQL `update` or `delete` q
[[association-fetching]]
=== Association fetching
:association-fetching: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#fetching
:association-fetching: {userGuideBase}#fetching
Achieving high performance in ORM means minimizing the number of round
trips to the database. This goal should be uppermost in your mind
@ -165,7 +165,7 @@ You can find much more information about association fetching in the
[[second-level-cache]]
=== The second-level cache
:second-level-cache: https://docs.jboss.org/hibernate/orm/6.2/userguide/html_single/Hibernate_User_Guide.html#caching
:second-level-cache: {userGuideBase}#caching
A classic way to reduce the number of accesses to the database is to use a second-level cache, allowing data cached in memory to be shared between sessions.