Skip to content

Commit a3ad85d

Browse files
committed
HHH-19869 Add links to dialect guide throughout the documentation
1 parent 3eda0e7 commit a3ad85d

File tree

5 files changed

+8
-3
lines changed

5 files changed

+8
-3
lines changed

documentation/src/main/asciidoc/dialect/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ Below is a list of supported dialects and the minimum required version of the da
2525

2626
include::{generated-report-dir}/dialect/dialect-table.adoc[]
2727

28+
[[community-dialects]]
2829
== Community dialects
2930

3031
Community dialects are not included in `org.hibernate.orm:hibernate-core` and require an additional dependency to `org.hibernate.orm:hibernate-community-dialects`.

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,7 @@ or `org.eclipse:yasson`
121121
| <<envers,Envers>>, for auditing historical data | `org.hibernate.orm:hibernate-envers`
122122
| <<jfr,Hibernate JFR>>, for monitoring via Java Flight Recorder | `org.hibernate.orm:hibernate-jfr`
123123
| Hibernate Jandex integration, for <<entity-discovery,entity discovery>> | `org.hibernate.orm:hibernate-scan-jandex`
124+
| link:{doc-dialect-url}#community-dialects[Community dialects] | `org.hibernate.orm:hibernate-community-dialects`
124125
|===
125126

126127
You might also add the Hibernate {enhancer}[bytecode enhancer] to your

documentation/src/main/asciidoc/quickstart/guides/obtaining.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ transitive dependencies based on the features being used or not.
5555
|hibernate-jcache| Integration with https://jcp.org/en/jsr/detail?id=107$$[JCache], allowing any compliant implementation as a second-level cache provider
5656
|hibernate-graalvm| Experimental extension to make it easier to compile applications as a https://www.graalvm.org/[GraalVM] native image
5757
|hibernate-micrometer| Integration with https://micrometer.io[Micrometer] metrics
58-
|hibernate-community-dialects| Additional community-supported SQL dialects
58+
|hibernate-community-dialects| Additional link:{doc-dialect-url}#community-dialects[community-supported SQL dialects]
5959
|===
6060

6161
[cols="40m,~"]

documentation/src/main/asciidoc/userguide/chapters/jdbc/Database_Access.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,5 +205,7 @@ Hibernate abstracts over variations between dialects of SQL via the class `org.h
205205
- There's a subclass of `Dialect` for each supported relational database in the package `org.hibernate.dialect`.
206206
- Additional community-supported ``Dialect``s are available in the separate module `hibernate-community-dialects`.
207207

208-
In Hibernate 6, it's no longer necessary to explicitly specify a dialect using the configuration property `hibernate.dialect`, and so setting that property is now discouraged.
208+
Starting with Hibernate 6, it's no longer necessary to explicitly specify a dialect using the configuration property `hibernate.dialect`, and so setting that property is now discouraged.
209209
(An exception is the case of custom user-written ``Dialect``s.)
210+
211+
NOTE: For information about available dialects and compatible database versions, see the link:{doc-dialect-url}[dialect guide].

documentation/src/main/asciidoc/userguide/chapters/portability/Portability.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ Regardless of the exact scenario, the basic idea is that you want Hibernate to h
1414

1515
The first line of portability for Hibernate is the dialect, which is a specialization of the `org.hibernate.dialect.Dialect` contract.
1616
A dialect encapsulates all the differences in how Hibernate must communicate with a particular database to accomplish some task like getting a sequence value or structuring a SELECT query.
17-
Hibernate bundles a wide range of dialects for many of the most popular databases.
17+
18+
Hibernate bundles a wide range of dialects for many of the most popular databases: see the link:{doc-dialect-url}[dialect guide] for details.
1819
If you find that your particular database is not among them, it is not terribly difficult to write your own.
1920

2021
[[portability-dialectresolver]]

0 commit comments

Comments
 (0)