Update documentation. #3174
Closed
Update documentation. #3174
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add section on reserved method names within repository interfaces.
mp911de
reviewed
Oct 10, 2024
| @@ -37,6 +37,11 @@ public interface CrudRepository<T, ID> extends Repository<T, ID> { | |||
| The methods declared in this interface are commonly referred to as CRUD methods. | |||
| `ListCrudRepository` offers equivalent methods, but they return `List` where the `CrudRepository` methods return an `Iterable`. | |||
|
|
|||
| [IMPORTANT] | |||
| ==== | |||
| The repository interface implies a few reserved methods like `findById(ID identifier)` that always target the domain types identifier property regardless of its property name. Read more about this in "`xref:repositories/query-methods-details.adoc#repositories.query-methods.reserved-methods[Defining Query Methods]`". | |||
There was a problem hiding this comment.
We need to watch for broken references in case a Data module doesn't ship a repositories/query-methods-details.adoc documentation page.
There was a problem hiding this comment.
is there one you're aware of right off the top of your head?
Add DDD context. Explain identifier to domain object relationship. Tweak wording.
mp911de
reviewed
Oct 10, 2024
| [TIP] | ||
| ==== | ||
| Spring Data considers domain types to be entities, more specifically aggregates. | ||
| So you will see the term "entity" used throughout the documentation that can be interchanged with the term "domain type" or "aggregate". |
There was a problem hiding this comment.
@odrotbohm any opinion on wording? We want to make the point that identifiers need sometimes a different handling than properties, yet in both cases we need to express access to these via some name.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add section on reserved method names within repository interfaces.
Related to: #3173