Skip to content

Commit 6a43f28

Browse files
Jay Bryantmp911de
authored andcommitted
DATAMONGO-2598 - Wording changes.
Removed the language of oppression and violence and replaced it with more neutral language. Note that problematic words in the code have to remain in the docs until the code changes. Original pull request: #872.
1 parent a44a003 commit 6a43f28

11 files changed

+51
-50
lines changed

src/main/asciidoc/new-features.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
[[new-features.2-1-0]]
4545
== What's New in Spring Data MongoDB 2.1
4646

47-
* Cursor-based aggregation execution.
47+
* Cursor-based aggregation.
4848
* <<mongo-template.query.distinct,Distinct queries>> for imperative and reactive Template APIs.
4949
* Support for Map/Reduce through the reactive Template API.
5050
* <<mongo.mongo-3.validation,`validator` support for collections>>.

src/main/asciidoc/reference/change-streams.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ In doubt, use `Document`.
1616

1717
Listening to a https://docs.mongodb.com/manual/tutorial/change-streams-example/[Change Stream by using a Sync Driver] creates a long running, blocking task that needs to be delegated to a separate component.
1818
In this case, we need to first create a `MessageListenerContainer`, which will be the main entry point for running the specific `SubscriptionRequest` tasks.
19-
Spring Data MongoDB already ships with a default implementation that operates on `MongoTemplate` and is capable of creating and executing `Task` instances for a `ChangeStreamRequest`.
19+
Spring Data MongoDB already ships with a default implementation that operates on `MongoTemplate` and is capable of creating and running `Task` instances for a `ChangeStreamRequest`.
2020

2121
The following example shows how to use Change Streams with `MessageListener` instances:
2222

@@ -39,7 +39,7 @@ container.stop();
3939
<1> Starting the container initializes the resources and starts `Task` instances for already registered `SubscriptionRequest` instances. Requests added after startup are ran immediately.
4040
<2> Define the listener called when a `Message` is received. The `Message#getBody()` is converted to the requested domain type. Use `Document` to receive raw results without conversion.
4141
<3> Set the collection to listen to and provide additional options through `ChangeStreamOptions`.
42-
<4> Register the request. The returned `Subscription` can be used to check the current `Task` state and cancel its execution to free resources.
42+
<4> Register the request. The returned `Subscription` can be used to check the current `Task` state and cancel it to free resources.
4343
<5> Do not forget to stop the container once you are sure you no longer need it. Doing so stops all running `Task` instances within the container.
4444
====
4545

src/main/asciidoc/reference/client-session-transactions.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ NOTE: `@Transactional(readOnly = true)` advises `MongoTransactionManager` to als
221221
== Reactive Transactions
222222

223223
Same as with the reactive `ClientSession` support, the `ReactiveMongoTemplate` offers dedicated methods for operating
224-
within a transaction without having to worry about the commit/abort actions depending on the operations outcome.
224+
within a transaction without having to worry about the committing or stopping actions depending on the operations outcome.
225225

226226
NOTE: Unless you specify a `ReactiveMongoTransactionManager` within your application context, transaction support is *DISABLED*. You can use `setSessionSynchronization(ALWAYS)` to participate in ongoing non-native MongoDB transactions.
227227

@@ -249,7 +249,7 @@ Mono<DeleteResult> result = Mono
249249
<1> First we obviously need to initiate the session.
250250
<2> Once we have the `ClientSession` at hand, start the transaction.
251251
<3> Operate within the transaction by passing on the `ClientSession` to the operation.
252-
<4> If the operations completes exceptionally, we need to abort the transaction and preserve the error.
252+
<4> If the operations completes exceptionally, we need to stop the transaction and preserve the error.
253253
<5> Or of course, commit the changes in case of success. Still preserving the operations result.
254254
<6> Lastly, we need to make sure to close the session.
255255
====
@@ -339,7 +339,7 @@ Inside transactions, MongoDB server has a slightly different behavior.
339339
*Connection Settings*
340340

341341
The MongoDB drivers offer a dedicated replica set name configuration option turing the driver into auto detection
342-
mode. This option helps identifying replica set master nodes and command routing during a transaction.
342+
mode. This option helps identifying replica set manager nodes and command routing during a transaction.
343343

344344
NOTE: Make sure to add `replicaSet` to the MongoDB URI. Please refer to https://docs.mongodb.com/manual/reference/connection-string/#connections-connection-options[connection string options] for further details.
345345

@@ -351,7 +351,7 @@ structures in place.
351351

352352
*Transient Errors*
353353

354-
MongoDB can add special labels to errors raised during transactional execution. Those may indicate transient failures
354+
MongoDB can add special labels to errors raised during transactional operations. Those may indicate transient failures
355355
that might vanish by merely retrying the operation.
356356
We highly recommend https://github.com/spring-projects/spring-retry[Spring Retry] for those purposes. Nevertheless
357357
one may override `MongoTransactionManager#doCommit(MongoTransactionObject)` to implement a https://docs.mongodb.com/manual/core/transactions/#retry-commit-operation[Retry Commit Operation]

src/main/asciidoc/reference/jmx.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[mongo.jmx]]
22
= JMX support
33

4-
The JMX support for MongoDB exposes the results of executing the 'serverStatus' command on the admin database for a single MongoDB server instance. It also exposes an administrative MBean, `MongoAdmin`, that lets you perform administrative operations, such as dropping or creating a database. The JMX features build upon the JMX feature set available in the Spring Framework. See https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#jmx[here] for more details.
4+
The JMX support for MongoDB exposes the results of running the 'serverStatus' command on the admin database for a single MongoDB server instance. It also exposes an administrative MBean, `MongoAdmin`, that lets you perform administrative operations, such as dropping or creating a database. The JMX features build upon the JMX feature set available in the Spring Framework. See https://docs.spring.io/spring/docs/{springVersion}/spring-framework-reference/integration.html#jmx[here] for more details.
55

66
[[mongodb:jmx-configuration]]
77
== MongoDB JMX Configuration

src/main/asciidoc/reference/mapping.adoc

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -548,6 +548,7 @@ public class Person<T extends Address> {
548548
}
549549
550550
// other getters/setters omitted
551+
}
551552
----
552553

553554
[TIP]
@@ -784,7 +785,7 @@ class Nested {
784785
[[mapping-usage-references]]
785786
=== Using DBRefs
786787

787-
The mapping framework does not have to store child objects embedded within the document. You can also store them separately and use a DBRef to refer to that document. When the object is loaded from MongoDB, those references are eagerly resolved so that you get back a mapped object that looks the same as if it had been stored embedded within your master document.
788+
The mapping framework does not have to store child objects embedded within the document. You can also store them separately and use a DBRef to refer to that document. When the object is loaded from MongoDB, those references are eagerly resolved so that you get back a mapped object that looks the same as if it had been stored embedded within your controlling document.
788789

789790
The following example uses a DBRef to refer to a specific document that exists independently of the object in which it is referenced (both classes are shown in-line for brevity's sake):
790791

src/main/asciidoc/reference/mongo-repositories-aggregation.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ To gain more control, you might consider `AggregationResult` as method return ty
7373
<8> Like in <6>, a single value can be directly obtained from multiple result ``Document``s.
7474
====
7575

76-
In some scenarios aggregations might require additional options like a maximum execution time, additional log comments or the permission to temporarily write data to disk.
76+
In some scenarios, aggregations might require additional options, such as a maximum run time, additional log comments, or the permission to temporarily write data to disk.
7777
Use the `@Meta` annotation to set those options via `maxExecutionTimeMs`, `comment` or `allowDiskUse`.
7878

7979
[source,java]

0 commit comments

Comments
 (0)