Update docs

rainboyan · rainboyan · commit da519600a2fa · 2025-12-24T00:33:52.000+08:00
diff --git a/src/docs/guide/advancedGORMFeatures.adoc b/src/docs/guide/advancedGORMFeatures.adoc
@@ -1 +1 @@
-The following sections cover more advanced usages of GORM including caching, custom mapping and events.
+The following sections cover more advanced usages of Grace Data including caching, custom mapping and events.
diff --git a/src/docs/guide/configuration.adoc b/src/docs/guide/configuration.adoc
@@ -1,3 +1,3 @@
-GORM for Hibernate can be configured with the `app/conf/application.yml` file when using Grace, the `src/main/resources/application.yml` file when using Spring Boot or by passing a `Map` or instanceof the `PropertyResolver` interface to the `org.grails.orm.hibernate.HibernateDatastore` class when used standalone.
+Grace Data Hibernate can be configured with the `app/conf/application.yml` file when using Grace, the `src/main/resources/application.yml` file when using Spring Boot or by passing a `Map` or instanceof the `PropertyResolver` interface to the `org.grails.orm.hibernate.HibernateDatastore` class when used standalone.
 
 All configuration options are read and materialized into an instance of link:{api}/org/grails/orm/hibernate/connections/HibernateConnectionSourceSettings.html[HibernateConnectionSourceSettings].
diff --git a/src/docs/guide/constraints.adoc b/src/docs/guide/constraints.adoc
@@ -1 +1 @@
-Constraints are how you define validation when using GORM entities.
+Constraints are how you define validation when using Grace Data entities.
diff --git a/src/docs/guide/domainClasses.adoc b/src/docs/guide/domainClasses.adoc
@@ -1,6 +1,6 @@
 When building applications you have to consider the problem domain you are trying to solve. For example if you were building an https://www.amazon.com/[Amazon]-style bookstore you would be thinking about books, authors, customers and publishers to name a few.
 
-These are modeled in GORM as Groovy classes, so a `Book` class may have a title, a release date, an ISBN number and so on. The next few sections show how to model the domain in GORM.
+These are modeled in Grace Data as Groovy classes, so a `Book` class may have a title, a release date, an ISBN number and so on. The next few sections show how to model the domain in GORM.
 
 Consider the following domain class:
 
diff --git a/src/docs/guide/gettingStarted.adoc b/src/docs/guide/gettingStarted.adoc
@@ -1,16 +1,16 @@
-To use GORM {version} for Hibernate in Grace 2023 you can specify the following configuration in `build.gradle`:
+To use Grace Data Hibernate {version} in Grace applications you can specify the following configuration in `build.gradle`:
 
 [source,groovy,subs="attributes"]
 ----
 dependencies {
-    compile "org.graceframework.plugins:hibernate:{version}"
+    implementation "org.graceframework:grace-boot-hibernate:{version}"
 }
 ----
 
-Otherwise if you are using an earlier version of Grace framework you can force the GORM version by adding the following block directly above the `dependencies` block:
+Otherwise if you are using an earlier version of Grace framework you can force the Grace Data Hibernate version by adding the following block directly above the `dependencies` block:
 
 [source,groovy,subs="attributes"]
 .build.gradle
 ----
-ext['grace-gorm.version'] = {version}
+ext['grace-data-hibernate.version'] = {version}
 ----
diff --git a/src/docs/guide/gettingStarted/hibernateVersions.adoc b/src/docs/guide/gettingStarted/hibernateVersions.adoc
@@ -1,50 +1,13 @@
-There are various changes you have to make to your build depending on the version of Grails when using GORM {version}.
+There are various changes you have to make to your build depending on the version of Grace framework when using Grace Data Hibernate {version}.
 
-==== Grails 3.2.x and above with Hibernate 4
+==== Grace framework 2024.0.x and above with Hibernate 5.6
 
-Grails 3.2.x is based on Spring Boot 1.4.x which enforces Hibernate 5.0.x as the default version. If you want to continue to use Hibernate 4 you must explicitly declare the Hibernate 4 dependences in `build.gradle`.
+Grace framework 2024.0.x is based on Spring Boot 3.4.x which enforces Hibernate 5.6.x as the default version.
 
 [source,groovy]
 .build.gradle
 ----
 dependencies {
-    compile "org.grails.plugins:hibernate4"
-    compile "org.hibernate:hibernate-core:4.3.10.Final"
-    compile "org.hibernate:hibernate-ehcache:4.3.10.Final"
+    implementation "org.graceframework:grace-boot-hibernate"
 }
 ----
-
-==== Grails 3.1.x and below with Hibernate 5
-
-Grails 3.1.x and below are based on Spring Boot 1.3.x which enforces Hibernate 4 as the default version of Hibernate, hence you have to use explicit versions to depend on Hibernate 5:
-
-[source,groovy]
-.build.gradle
-----
-dependencies {
-    compile "org.grails.plugins:hibernate5"
-    compile "org.hibernate:hibernate-core:5.1.0.Final"
-    compile "org.hibernate:hibernate-ehcache:5.1.0.Final"
-}
-----
-
-==== Grails 3.0.x Spring Version Conflicts
-
-Grails 3.0.x enforces Spring 4.1.x as the Spring version, so if you want to use Hibernate 5 you must force an upgrade to Spring 4.2.x in `build.gradle`:
-
-[source,groovy]
-.build.gradle
-----
-// the below is unnecessary in Grails 3.1 and above, but required in Grails 3.0.x
-configurations.all {
-    resolutionStrategy {
-        eachDependency { DependencyResolveDetails details ->
-            if(details.requested.group == 'org.springframework') {
-                details.useVersion('4.2.3.RELEASE')
-            }
-        }
-    }
-}
-----
-
-The `resolutionStrategy` is needed to enforce an upgrade to Spring 4.2.x which is required by Hibernate 5 support. This block is not needed if you are using Grails 3.1 or above.
diff --git a/src/docs/guide/gettingStarted/outsideGrails.adoc b/src/docs/guide/gettingStarted/outsideGrails.adoc
@@ -1,12 +1,11 @@
-If you wish to use GORM for Hibernate outside of a Grails application you should declare the necessary dependencies for GORM and the database you are using, for example in Gradle:
+If you wish to use Grace Data Hibernate outside of a Grails application you should declare the necessary dependencies for GORM and the database you are using, for example in Gradle:
 
 [source,groovy,subs="attributes"]
 ----
-compile "org.grails:grails-datastore-gorm-hibernate5:{version}"
-runtime "com.h2database:h2:1.4.192"
-runtime "org.apache.tomcat:tomcat-jdbc:8.5.0"
-runtime "org.apache.tomcat.embed:tomcat-embed-logging-log4j:8.5.0"
-runtime "org.slf4j:slf4j-api:1.7.10"
+implementation "org.graceframework:grace-boot:{version}"
+implementation "org.graceframework:grace-boot-hibernate:{version}"
+implementation "org.graceframework:grace-boot-persistence:{version}"
+runtimeOnly "com.h2database:h2:2.3.232"
 ----
 
 NOTE: The above example also uses the https://www.h2database.com[H2 Database] and Tomcat connection pool.
diff --git a/src/docs/guide/gettingStarted/springBoot.adoc b/src/docs/guide/gettingStarted/springBoot.adoc
@@ -1,20 +1,19 @@
-To use GORM for Hibernate in Spring Boot add the necessary dependencies to your Boot application:
+To use Grace Data Hibernate in Spring Boot add the necessary dependencies to your Boot application:
 
 [source,groovy,subs="attributes"]
 ----
-compile("org.grails:gorm-hibernate5-spring-boot:{version}")
-compile "org.hibernate:hibernate-core"
-compile "org.hibernate:hibernate-ehcache"
-runtime "com.h2database:h2:1.4.192"
+implementation "org.graceframework:grace-boot:{version}"
+implementation "org.graceframework:grace-boot-hibernate:{version}"
+implementation "org.hibernate:hibernate-jcache"
+runtimeOnly "com.h2database:h2"
 // for MySQL
-// runtime "mysql:mysql-connector-java"
+// runtimeOnly "mysql:mysql-connector-java"
 
 // for connection pooling
-runtime "org.apache.tomcat:tomcat-jdbc:8.5.0"
-runtime "org.apache.tomcat.embed:tomcat-embed-logging-log4j:8.5.0"
+runtimeOnly "org.apache.tomcat:tomcat-jdbc"
 ----
 
-Then ensure you have configured a https://docs.spring.io/spring-boot/3.3/reference/data/sql.html[datasource and Hibernate as per the Spring Boot guide]. For example in the case of MySQL:
+Then ensure you have configured a https://docs.spring.io/spring-boot/3.4/reference/data/sql.html[datasource and Hibernate as per the Spring Boot guide]. For example in the case of MySQL:
 
 [source,yaml]
 ----
@@ -30,28 +29,21 @@ spring:
         password: ""
 ----
 
-TIP: If if you prefer to use the Grails way of configuring the `DataSource` (with `dataSource.url` etc.) then you can add `@EnableAutoConfiguration(exclude = DataSourceAutoConfiguration)` to your `Application` class, which will allow GORM to take over configuring the data source.
-
-Ensure your Boot `Application` class is annotated with `ComponentScan`, for example:
-
 [source,groovy]
 ----
 import org.springframework.boot.SpringApplication
-import org.springframework.boot.autoconfigure.EnableAutoConfiguration
-import org.springframework.context.annotation.*
+import org.springframework.boot.autoconfigure.SpringBootApplication
 
-@Configuration
-@EnableAutoConfiguration
-@ComponentScan
+@SpringBootApplication
 class Application {
     static void main(String[] args) {
         SpringApplication.run Application, args
     }
 }
 ----
 
-NOTE: Using `ComponentScan` without a value results in Boot scanning for classes in the same package or any package nested within the `Application` class package.
-If your GORM entities are in a different package specify the package name as the value of the `ComponentScan` annotation.
+NOTE: Using `@GraceComponentScan` without a value results in Boot scanning for classes in the same package or any package nested within the `Application` class package.
+If your GORM entities are in a different package specify the package name as the value of the `@GraceComponentScan` annotation.
 
 Finally create your GORM entities and ensure they are annotated with `grails.persistence.Entity`:
 
diff --git a/src/docs/guide/index.adoc b/src/docs/guide/index.adoc
@@ -1,4 +1,4 @@
-= GORM for Hibernate
+= Grace Data Hibernate
 Graeme Rocher, Puneet Behl
 :imagesdir: ./images
 :source-highlighter: coderay
diff --git a/src/docs/guide/introduction.adoc b/src/docs/guide/introduction.adoc
@@ -1,7 +1,7 @@
-https://graceframework.org/grace-data/2023.3.x/[GORM] is a data access framework with multiple backend implementations that allows you to rapidly write data access code with little effort for your favourite database.
+https://graceframework.org/grace-data/2024.0.x/[Grace Data] is a data access framework with multiple backend implementations that allows you to rapidly write data access code with little effort for your favourite database.
 
-There are currently several implementations of GORM. This documentation covers the original implementation of GORM which is based on the https://hibernate.org/orm/[Hibernate ORM]. Below you can find links to the other implementations:
+There are currently several implementations of Grace Data. This documentation covers the original implementation of Grace Data which is based on the https://hibernate.org/orm/[Hibernate ORM]. Below you can find links to the other implementations:
 
-* https://graceframework.org/grace-data-mongodb/2023.3.x/[GORM for MongoDB]
+* https://graceframework.org/grace-data-mongodb/2024.0.x/[Grace Data MongoDB]
 
-As mentioned, https://github.com/graceframework/grace-data-hibernate[GORM for Hibernate] is the original implementation of GORM and has evolved dramatically over the years from a few meta-programming functions into a complete data access framework with multiple implementations for different datastores relational and NoSQL.
+As mentioned, https://github.com/graceframework/grace-data-hibernate[Grace Data Hibernate] is the original implementation of GORM and has evolved dramatically over the years from a few meta-programming functions into a complete data access framework with multiple implementations for different datastores relational and NoSQL.
diff --git a/src/docs/guide/learningMore.adoc b/src/docs/guide/learningMore.adoc
@@ -1 +1 @@
-The full documentation for GORM for Hibernate can be found in the https://docs.graceframework.org/latest/guide/GORM.html[The Grace Framework User Guide], this documentation serves to explain how to get started with GORM for Hibernate with or without Grace and to document release notes.
+The full documentation for Grace Data Hibernate can be found in the https://graceframework.org/grace-data-hibernate/2024.0.x[Grace Data Hibernatee], this documentation serves to explain how to get started with Grace Data Hibernate with or without Grace and to document release notes.
diff --git a/src/docs/guide/multipleDataSources.adoc b/src/docs/guide/multipleDataSources.adoc
@@ -1 +1 @@
-GORM supports the notion of multiple data sources where multiple individual SQL `DataSource` instances can be configured and switched between.
+Grace Data Hibernate supports the notion of multiple data sources where multiple individual SQL `DataSource` instances can be configured and switched between.
diff --git a/src/docs/guide/persistenceBasics.adoc b/src/docs/guide/persistenceBasics.adoc
@@ -1,4 +1,4 @@
-A key thing to remember about GORM is that under the surface GORM is using https://www.hibernate.org/[Hibernate] for persistence. If you are coming from a background of using https://api.rubyonrails.org/classes/ActiveRecord/Base.html[ActiveRecord] or https://www.mybatis.org/[iBatis/MyBatis], Hibernate's "session" model may feel a little strange.
+A key thing to remember about Grace Data is that under the surface GORM is using https://www.hibernate.org/[Hibernate] for persistence. If you are coming from a background of using https://api.rubyonrails.org/classes/ActiveRecord/Base.html[ActiveRecord] or https://www.mybatis.org/[iBatis/MyBatis], Hibernate's "session" model may feel a little strange.
 
 If you are using Grace, then Grace automatically binds a Hibernate session to the currently executing request. This lets you use the `save()` and `delete` methods as well as other GORM methods transparently.
 
diff --git a/src/docs/guide/programmaticTransactions.adoc b/src/docs/guide/programmaticTransactions.adoc
@@ -1,3 +1,3 @@
-GORM's transaction management is built on Spring and uses Spring's Transaction abstraction for dealing with programmatic transactions.
+Grace Data's transaction management is built on Spring and uses Spring's Transaction abstraction for dealing with programmatic transactions.
 
-However, GORM classes have been enhanced to make this simpler with the link:{gormapi}/org/grails/datastore/gorm/GormEntity.html#withTransaction(groovy.lang.Closure)[withTransaction(Closure)]  method. This method has a single parameter, a Closure, which has a single parameter which is a Spring link:{springapi}/org/springframework/transaction/TransactionStatus.html[TransactionStatus] instance.
+However, Grace Data classes have been enhanced to make this simpler with the link:{gormapi}/org/grails/datastore/gorm/GormEntity.html#withTransaction(groovy.lang.Closure)[withTransaction(Closure)]  method. This method has a single parameter, a Closure, which has a single parameter which is a Spring link:{springapi}/org/springframework/transaction/TransactionStatus.html[TransactionStatus] instance.
diff --git a/src/docs/guide/querying.adoc b/src/docs/guide/querying.adoc
@@ -1,4 +1,4 @@
-GORM supports a number of powerful ways to query from dynamic finders, to criteria to Hibernate's object oriented query language HQL. Depending on the complexity of the query you have the following options in order of flexibility and power:
+Grace Data Hibernate supports a number of powerful ways to query from dynamic finders, to criteria to Hibernate's object oriented query language HQL. Depending on the complexity of the query you have the following options in order of flexibility and power:
 
 * Dynamic Finders
 * Where Queries
diff --git a/src/docs/guide/services.adoc b/src/docs/guide/services.adoc
@@ -1,3 +1,3 @@
-Introduced in GORM 6.1, Data Services take the work out of implemented service layer logic by adding the ability to automatically implement abstract classes or interfaces using GORM logic.
+Introduced in Grace Data 6.1, Data Services take the work out of implemented service layer logic by adding the ability to automatically implement abstract classes or interfaces using GORM logic.
 
-To illustrate what GORM Data Services are about let's walk through an example.
+To illustrate what Grace Data Services are about let's walk through an example.
diff --git a/src/docs/guide/testing.adoc b/src/docs/guide/testing.adoc
@@ -1,3 +1,3 @@
-In previous versions of GORM it was much more difficult to setup a unit test to test your GORM logic.
+In previous versions of Grace Data it was much more difficult to setup a unit test to test your Grace Data logic.
 
-However, since GORM 6.0, this situation has changed and it is relatively trivial to setup GORM for testing.
+However, since Grace Data 6.0, this situation has changed and it is relatively trivial to setup GORM for testing.

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-The following sections cover more advanced usages of GORM including caching, custom mapping and events.`
	`1`	`+The following sections cover more advanced usages of Grace Data including caching, custom mapping and events.`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		-GORM for Hibernate can be configured with the `app/conf/application.yml` file when using Grace, the `src/main/resources/application.yml` file when using Spring Boot or by passing a `Map` or instanceof the `PropertyResolver` interface to the `org.grails.orm.hibernate.HibernateDatastore` class when used standalone.
	`1`	+Grace Data Hibernate can be configured with the `app/conf/application.yml` file when using Grace, the `src/main/resources/application.yml` file when using Spring Boot or by passing a `Map` or instanceof the `PropertyResolver` interface to the `org.grails.orm.hibernate.HibernateDatastore` class when used standalone.
`2`	`2`
`3`	`3`	`All configuration options are read and materialized into an instance of link:{api}/org/grails/orm/hibernate/connections/HibernateConnectionSourceSettings.html[HibernateConnectionSourceSettings].`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-Constraints are how you define validation when using GORM entities.`
	`1`	`+Constraints are how you define validation when using Grace Data entities.`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-= GORM for Hibernate`
	`1`	`+= Grace Data Hibernate`
`2`	`2`	`Graeme Rocher, Puneet Behl`
`3`	`3`	`:imagesdir: ./images`
`4`	`4`	`:source-highlighter: coderay`