Update docs

rainboyan · rainboyan · commit 286089a8b5b0 · 2025-12-23T17:16:53.000+08:00
- Replace 'GORM for MongoDB' to 'Grace Data MongoDB'
diff --git a/src/docs/guide/gettingStarted.adoc b/src/docs/guide/gettingStarted.adoc
@@ -1,11 +1,11 @@
 == Basic Setup
 
-To get started with GORM for MongoDB within Grails you need configure it as a dependency in `build.gradle`:
+To get started with Grace Data MongoDB within Grace framework you need configure it as a dependency in `build.gradle`:
 
 [source,groovy,subs="attributes"]
 ----
 dependencies {
-    implementation 'org.graceframework.plugins:mongodb:{version}'
+    implementation 'org.graceframework:grace-boot-mongodb:{version}'
 }
 ----
 
diff --git a/src/docs/guide/gettingStarted/advancedConfig.adoc b/src/docs/guide/gettingStarted/advancedConfig.adoc
@@ -1,6 +1,6 @@
 === Mongo Database Connection Configuration
 
-As mentioned the GORM for MongoDB plugin will configure all the defaults for you, but if you wish to customize those defaults you can do so in the `app/conf/application.groovy` file:
+As mentioned the Grace Data MongoDB plugin will configure all the defaults for you, but if you wish to customize those defaults you can do so in the `app/conf/application.groovy` file:
 
 [source,groovy]
 ----
diff --git a/src/docs/guide/gettingStarted/outsideGrails.adoc b/src/docs/guide/gettingStarted/outsideGrails.adoc
@@ -1,9 +1,9 @@
-If you wish to use GORM for MongoDB outside of a Grace application you should declare the necessary dependencies, for example in Gradle:
+If you wish to use Grace Data MongoDB outside of a Grace application you should declare the necessary dependencies, for example in Gradle:
 
 [source,groovy,subs="attributes"]
 ----
 implementation "org.graceframework:grace-boot:{version}"
-implementation "org.graceframework.plugins:mongodb:{version}"
+implementation "org.graceframework:grace-boot-mongodb:{version}"
 ----
 
 Then annotate your entities with the `grails.gorm.annotation.Entity` annotation:
diff --git a/src/docs/guide/gettingStarted/springBoot.adoc b/src/docs/guide/gettingStarted/springBoot.adoc
@@ -1,18 +1,20 @@
-To use GORM for MongoDB in Spring Boot add the necessary dependencies to your Boot application:
+To use Grace Data MongoDB in Spring Boot add the necessary dependencies to your Spring Boot application:
 
 [source,groovy,subs="attributes"]
 ----
 implementation "org.graceframework:grace-boot:{version}"
-implementation "org.graceframework.plugins:mongodb:{version}"
+implementation "org.graceframework:grace-boot-mongodb:{version}"
 ----
 
-Ensure your Boot `Application` class is annotated with `GrailsComponentScan`, example:
+Ensure your Boot `Application` class is annotated with `@GrailsComponentScan`, example:
 
 [source,groovy]
 ----
+import grails.boot.GrailsComponentScan
 import org.springframework.boot.SpringApplication
 import org.springframework.boot.autoconfigure.SpringBootApplication
 
+@GrailsComponentScan
 @SpringBootApplication
 class Application {
     static void main(String[] args) {
@@ -21,7 +23,7 @@ class Application {
 }
 ----
 
-NOTE: Using `GrailsComponentScan` without a value results in Boot scanning for classes in the same package or any package nested within the `Application` class package.
+NOTE: Using `@GrailsComponentScan` 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 `GrailsComponentScan` 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 MongoDB
+= Grace Data MongoDB
 Graeme Rocher, Burt Beckwith, Puneet Behl
 :revnumber: {version}
 :imagesdir: ./images
@@ -50,7 +50,7 @@ include::gettingStarted/advancedConfig.adoc[]
 include::gettingStarted/springBoot.adoc[]
 
 [[outsideGrails]]
-=== GORM for MongoDB without Grails
+=== Grace Data MongoDB without Grails
 
 include::gettingStarted/outsideGrails.adoc[]
 
diff --git a/src/docs/guide/introduction/upgradeNotes.adoc b/src/docs/guide/introduction/upgradeNotes.adoc
@@ -1,6 +1,6 @@
 ==== Dependency Upgrades
 
-GORM 2023.3 supports Apache Groovy 4.0, Java 17, MongoDB Driver 5.0 and Spring 6.1.x.
+Grace Data MongoDB {version} supports Apache Groovy 4.0, Java 17, MongoDB Driver 5.2 and Spring 6.2.x.
 
 Each of these underlying components may have changes that require altering your application. These changes are beyond the scope of this documentation.
 
diff --git a/src/docs/guide/multiTenancy/dynamicConnectionSources.adoc b/src/docs/guide/multiTenancy/dynamicConnectionSources.adoc
@@ -30,4 +30,4 @@ MongoClient mongoClient =
 
 All new connection sources will be stored within the specified `connectionsCollection` and if the application is restarted will read from the `connectionsCollection`.
 
-WARNING: GORM for MongoDB does not implement provisioning of new MongoDB instances at runtime. This is something that would need to be implemented by a cloud services provider for example.
+WARNING: Grace Data MongoDB does not implement provisioning of new MongoDB instances at runtime. This is something that would need to be implemented by a cloud services provider for example.
diff --git a/src/docs/guide/multiTenancy/multiTenancyModes.adoc b/src/docs/guide/multiTenancy/multiTenancyModes.adoc
@@ -1,4 +1,4 @@
-As mentioned previously, GORM for MongoDB supports all three multi tenancy modes however there are some considerations to keep in mind.
+As mentioned previously, Grace Data MongoDB supports all three multi tenancy modes however there are some considerations to keep in mind.
 
 === Database Per Tenant
 
@@ -35,7 +35,7 @@ MongoClient mongoClient =
 
 === Schema Per Tenant
 
-When using the `SCHEMA` mode, GORM for MongoDB will use a different MongoDB database, but the same `MongoClient` instance, for each tenant.
+When using the `SCHEMA` mode, Grace Data MongoDB will use a different MongoDB database, but the same `MongoClient` instance, for each tenant.
 
 However, once again only GORM methods will use the correct database. For example:
 
@@ -65,7 +65,7 @@ Book.DB.find()
 
 === Partitioned Multi-Tenancy
 
-When using the `DISCRIMINATOR` approach, GORM for MongoDB will store a `tenantId` attribute in each MongoDB document and attempt to partition the data.
+When using the `DISCRIMINATOR` approach, Grace Data MongoDB will store a `tenantId` attribute in each MongoDB document and attempt to partition the data.
 
 Once again this works only when using GORM methods and even then there are cases where it will not work if you use native MongoDB interfaces.
 
diff --git a/src/docs/guide/multipleDataSources.adoc b/src/docs/guide/multipleDataSources.adoc
@@ -1 +1 @@
-GORM for MongoDB supports the notion of multiple data sources where multiple individual `MongoClient` instances can be configured and switched between.
+Grace Data MongoDB supports the notion of multiple data sources where multiple individual `MongoClient` instances can be configured and switched between.
diff --git a/src/docs/guide/multipleDataSources/connectionSources.adoc b/src/docs/guide/multipleDataSources/connectionSources.adoc
@@ -1,4 +1,4 @@
-Introduced in GORM 6.0, the link:{api}/org/grails/datastore/mapping/core/connections/ConnectionSources.html[ConnectionSources] API allows you to introspect the data sources configured for the application:
+Introduced in Grace Data 2022.0, the link:{api}/org/grails/datastore/mapping/core/connections/ConnectionSources.html[ConnectionSources] API allows you to introspect the data sources configured for the application:
 
 [source,groovy]
 ----
diff --git a/src/docs/guide/multipleDataSources/index.adoc b/src/docs/guide/multipleDataSources/index.adoc
@@ -1,4 +1,4 @@
-GORM for MongoDB supports the notion of multiple data sources where multiple individual `MongoClient` instances can be configured and switched between.
+Grace Data MongoDB supports the notion of multiple data sources where multiple individual `MongoClient` instances can be configured and switched between.
 
 === Configuring Multiple Mongo Clients
 
diff --git a/src/docs/guide/objectMapping.adoc b/src/docs/guide/objectMapping.adoc
@@ -1,6 +1,6 @@
 == Basic Mapping
 
-The way GORM for MongoDB works is to map each domain class to a Mongo collection. For example given a domain class such as:
+The way Grace Data MongoDB works is to map each domain class to a Mongo collection. For example given a domain class such as:
 
 [source,groovy]
 ----
@@ -15,7 +15,7 @@ This will map onto a MongoDB https://api.mongodb.org/java/current/com/mongodb/cl
 
 == Embedded Documents
 
-It is quite common in MongoDB to embed documents within documents (nested documents). This can be done with GORM embedded types:
+It is quite common in MongoDB to embed documents within documents (nested documents). This can be done with Grace Data MongoDB embedded types:
 
 [source,groovy]
 ----
@@ -99,7 +99,7 @@ class Person {
 }
 ----
 
-If you are using the mapping engine, for non-embedded associations by default GORM for MongoDB will map links between documents using MongoDB https://www.mongodb.com/docs/manual/reference/database-references/[database references] also known as `DBRefs`.
+If you are using the mapping engine, for non-embedded associations by default Grace Data MongoDB will map links between documents using MongoDB https://www.mongodb.com/docs/manual/reference/database-references/[database references] also known as `DBRefs`.
 
 If you prefer not to use DBRefs then you tell GORM to use direct links by using the `reference:false` mapping:
 
diff --git a/src/docs/guide/objectMapping/customTypes.adoc b/src/docs/guide/objectMapping/customTypes.adoc
@@ -1,8 +1,8 @@
-GORM for MongoDB will persist all common known Java types like String, Integer, URL etc., however if you want to persist one of your own classes that is not a domain class you can implement a custom user type.
+Grace Data MongoDB will persist all common known Java types like String, Integer, URL etc., however if you want to persist one of your own classes that is not a domain class you can implement a custom user type.
 
 === Custom Codecs
 
-GORM for MongoDB is built ontop of MongoDB's BSON encoding framework. This means it is possible to implement custom https://mongodb.github.io/mongo-java-driver/5.0/bson/codecs/[Codecs] for encoding and decoding values to and from BSON.
+Grace Data MongoDB is built ontop of MongoDB's BSON encoding framework. This means it is possible to implement custom https://mongodb.github.io/mongo-java-driver/5.0/bson/codecs/[Codecs] for encoding and decoding values to and from BSON.
 
 For example consider the following simple Groovy class:
 
diff --git a/src/docs/guide/objectMapping/dirtyChecking.adoc b/src/docs/guide/objectMapping/dirtyChecking.adoc
@@ -13,7 +13,7 @@ if (person.hasChanged('firstName')) {
 
 This method is defined by the `org.grails.datastore.mapping.dirty.checking.DirtyCheckable` trait.
 
-In the case of collections and association types GORM for MongoDB will wrap each collection in a dirty checking aware
+In the case of collections and association types Grace Data MongoDB will wrap each collection in a dirty checking aware
 collection type.
 
 One of the implications of this is if you override the collection with a non-dirty checking aware type it can disable
@@ -26,7 +26,7 @@ If any of your updates are not updating the properties that you anticipate you c
 person.markDirty('firstName')
 ----
 
-This will force GORM for MongoDB to issue an update for the given property name.
+This will force Grace Data MongoDB to issue an update for the given property name.
 
 === Dirty Checking and Proxies
 
diff --git a/src/docs/guide/objectMapping/dynamicAttributes.adoc b/src/docs/guide/objectMapping/dynamicAttributes.adoc
@@ -8,7 +8,7 @@ class Plant {
 }
 ----
 
-Here there are two fixed properties, `name` and `goesInPatch`, that will be persisted into the MongoDB document. Using GORM for MongoDB you can however use dynamic properties via the Groovy subscript operator. For example:
+Here there are two fixed properties, `name` and `goesInPatch`, that will be persisted into the MongoDB document. Using Grace Data MongoDB you can however use dynamic properties via the Groovy subscript operator. For example:
 
 [source,groovy]
 ----
diff --git a/src/docs/guide/querying/geoSpatial.adoc b/src/docs/guide/querying/geoSpatial.adoc
@@ -1,3 +1,3 @@
 MongoDB supports storing https://www.mongodb.com/docs/manual/geospatial-queries/#geospatial-data[Geospacial data] in both flat and spherical surface types.
 
-To store data in a flat surface you use a "2d" index, whilst a "2dsphere" index used for spherical data. GORM for MongoDB supports both and the following sections describe how to define and query Geospacial data.
+To store data in a flat surface you use a "2d" index, whilst a "2dsphere" index used for spherical data. Grace Data MongoDB supports both and the following sections describe how to define and query Geospacial data.
diff --git a/src/docs/guide/querying/geoSpatial/2dsphere.adoc b/src/docs/guide/querying/geoSpatial/2dsphere.adoc
@@ -6,7 +6,7 @@ Although you can use coordinate pairs in a 2dsphere index, they are considered l
 
 WARNING: MongoDB legacy coordinate pairs are in latitude / longitude order, whilst GeoJSON points are stored in longitude / latitude order!
 
-To support this GORM for MongoDB features a special type, `grails.mongodb.geo.Point`, that can be used within domain classes to store geospacial data:
+To support this Grace Data MongoDB features a special type, `grails.mongodb.geo.Point`, that can be used within domain classes to store geospacial data:
 
 [source,groovy]
 ----
diff --git a/src/docs/guide/querying/queryIndexes.adoc b/src/docs/guide/querying/queryIndexes.adoc
@@ -44,7 +44,7 @@ Person.withCriteria {
 
 === Compound Indices
 
-MongoDB supports the notion of https://www.mongodb.com/docs/manual/core/indexes/index-types/index-compound/[compound keys]. GORM for MongoDB enables this feature at the mapping level using the `compoundIndex` mapping:
+MongoDB supports the notion of https://www.mongodb.com/docs/manual/core/indexes/index-types/index-compound/[compound keys]. Grace Data MongoDB enables this feature at the mapping level using the `compoundIndex` mapping:
 
 [source,groovy]
 ----
diff --git a/src/docs/guide/querying/queryingBasics.adoc b/src/docs/guide/querying/queryingBasics.adoc
@@ -1,4 +1,4 @@
-GORM for MongoDB supports all of the https://graceframework.org/grace-data-hibernate/2023.3.x/guide/querying.html[regular methods] for executing GORM queries apart from HQL, which is a Hibernate specific query language more appropriate for SQL databases.
+Grace Data MongoDB supports all of the https://graceframework.org/grace-data-hibernate/2023.3.x/guide/querying.html[regular methods] for executing GORM queries apart from HQL, which is a Hibernate specific query language more appropriate for SQL databases.
 
 If you wish to execute a native MongoDB query you can use the `find` method that takes a https://mongodb.github.io/mongo-java-driver/5.0/apidocs/bson/org/bson/conversions/Bson.html[Bson] argument. For example:
 
diff --git a/src/docs/guide/stateless.adoc b/src/docs/guide/stateless.adoc
@@ -1,8 +1,8 @@
-GORM for MongoDB supports both stateless and stateful modes for mapping domain classes to MongoDB. In general stateful mapping is superior for write heavy applications and stateless mode better for read heavy applications (particularily when large amounts of data is involved).
+Grace Data MongoDB supports both stateless and stateful modes for mapping domain classes to MongoDB. In general stateful mapping is superior for write heavy applications and stateless mode better for read heavy applications (particularily when large amounts of data is involved).
 
 == Stateful mode
 
-Domain classes are by default stateful, which means when they are read from a MongoDB document their state is stored in the user session (which is typically bound to the request in Grails). This has several advantages for write heavy applications:
+Domain classes are by default stateful, which means when they are read from a MongoDB document their state is stored in the user session (which is typically bound to the request in the Grace framework). This has several advantages for write heavy applications:
 
 * GORM can automatically detect whether a call to save() is a an update or an insert and act appropriately
 * GORM stores the state of the read MongoDB document and therefore updates to schemaless properties don't require an extra query
@@ -69,7 +69,7 @@ b.id = "The Book"
 b.insert()
 ----
 
-In the above case we use the explicit 'insert' method to tell Grails this is an insert not an udpate. Another disadvantage is that reading of schemaless/dynamic properties is more costly. For example:
+In the above case we use the explicit 'insert' method to tell the Grace framework this is an insert not an udpate. Another disadvantage is that reading of schemaless/dynamic properties is more costly. For example:
 
 [source,groovy]
 ----
diff --git a/src/docs/guide/toc.yml b/src/docs/guide/toc.yml
@@ -13,8 +13,7 @@ gettingStarted:
     mongoOnly: Using MongoDB Standalone
     withHibernate: Combining MongoDB and Hibernate
     advancedConfig: Advanced Configuration
-    springBoot: Using GORM in Spring Boot
-    outsideGrails: GORM for MongoDB without Grails
+    springBoot: Using Grace Data MongoDB in Spring Boot
 
 objectMapping:
     title: Mapping Domain Classes
diff --git a/src/docs/guide/transactions.adoc b/src/docs/guide/transactions.adoc
@@ -1,4 +1,4 @@
-MongoDB doesn't support transactions directly, however GORM for MongoDB does batch up inserts and updates until the session is flushed. This makes it possible to support some rollback options.
+MongoDB doesn't support transactions directly, however Grace Data MongoDB does batch up inserts and updates until the session is flushed. This makes it possible to support some rollback options.
 
 You can use either transactional services or the static `withTransaction` method. To mark a service as using the MongoDB transaction manager, use the static `transactional` property with the value `'mongo'`:
 

Original file line number	Diff line number	Diff line change
`@@ -30,4 +30,4 @@ MongoClient mongoClient =`
`30`	`30`
`31`	`31`	All new connection sources will be stored within the specified `connectionsCollection` and if the application is restarted will read from the `connectionsCollection`.
`32`	`32`
`33`		`-WARNING: GORM for MongoDB does not implement provisioning of new MongoDB instances at runtime. This is something that would need to be implemented by a cloud services provider for example.`
	`33`	`+WARNING: Grace Data MongoDB does not implement provisioning of new MongoDB instances at runtime. This is something that would need to be implemented by a cloud services provider for example.`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		-GORM for MongoDB supports the notion of multiple data sources where multiple individual `MongoClient` instances can be configured and switched between.
	`1`	+Grace Data MongoDB supports the notion of multiple data sources where multiple individual `MongoClient` instances can be configured and switched between.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-Introduced in GORM 6.0, the link:{api}/org/grails/datastore/mapping/core/connections/ConnectionSources.html[ConnectionSources] API allows you to introspect the data sources configured for the application:`
	`1`	`+Introduced in Grace Data 2022.0, the link:{api}/org/grails/datastore/mapping/core/connections/ConnectionSources.html[ConnectionSources] API allows you to introspect the data sources configured for the application:`
`2`	`2`
`3`	`3`	`[source,groovy]`
`4`	`4`	`----`