Skip to content

Extend the documentation about how to declare repositories. #2568

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from

Conversation

schauder
Copy link
Contributor

@schauder schauder commented Mar 2, 2022

The new version goes into more details of the various options and is heavily based on changes made for version 3.0.x

Closes #2536
See #2537

@schauder schauder requested a review from mp911de March 2, 2022 09:00
@mp911de mp911de changed the base branch from main to 2.7.x June 3, 2022 07:45

NOTE: Doing so lets you define your own abstractions on top of the provided Spring Data Repositories functionality.
The typical approach is to extend `CrudRepository`, which gives you methods for CRUD functionality.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should start with Repository or the @RepositoryDefinition annotation. Then guide towards exposing individual methods (see CRUD repo signatures) over declared query methods and then pick up on extending CrudRepository.

That sequence of guidance reflects our general approach (make up your mind what you need instead of blindly extending just a repo).

The next few paragraphs should be adopted to that flow. Once that's done, then this PR is good for being merged.

@mp911de
Copy link
Member

mp911de commented Feb 27, 2023

Our 3.0 changes introduced conflicts into this PR. Care to rebase this one?

The new version goes into more details of the various options and is heavily based on changes made for version 3.0.x

Closes #2536
See #2537
@schauder schauder force-pushed the issue/2536-iterable-documentation branch from b09a0c5 to 1b05fd9 Compare February 27, 2023 09:58
@schauder
Copy link
Contributor Author

The changes are already on main. Looks like we made it part of the change to the interfaces: 37eee0e

I suggest, we close this PR, and possibly make a new one for the requested change.

@mp911de
Copy link
Member

mp911de commented Mar 21, 2023

Closing as per @schauder's request.

@mp911de mp911de closed this Mar 21, 2023
@mp911de mp911de deleted the issue/2536-iterable-documentation branch March 21, 2023 09:51
@mp911de mp911de added the status: declined A suggestion or change that we don't feel we should currently apply label Mar 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: declined A suggestion or change that we don't feel we should currently apply
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve documentation with regard to returning multiple elements from a repository method.
2 participants