Skip to content
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

Add documentation for JdbcAggregateTemplate. #1854

Closed
wants to merge 3 commits into from

Conversation

schauder
Copy link
Contributor

Closes #1841

@schauder
Copy link
Contributor Author

Hey @Buzzardo,
if you have some spare time at your hands, I'd appreciate a round of polishing on this PR.

src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
src/main/antora/modules/ROOT/pages/jdbc/template.adoc Outdated Show resolved Hide resolved
@mp911de mp911de added the type: documentation A documentation update label Aug 13, 2024
[[jdbc.template]]
= Template API

Spring Data JDBC offers the javadoc:org.springframework.data.jdbc.core.JdbcAggregateTemplate[] as a more direct means to load and persist entities in a relational database.
Copy link
Member

Choose a reason for hiding this comment

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

This page adds another variant of documenting Template API's.

I strongly suggest aligning with https://docs.spring.io/spring-data/relational/reference/r2dbc/entity-persistence.html to not introduce yet another variant of Template documentation.

Overall, entity-persistence.html would be a good place to explain the Template API as it fits pretty well in there surrounded by Optimistic Locking and ID generation.

Furthermore, the documentation misses update and delete method documentation.

schauder added a commit that referenced this pull request Aug 14, 2024
schauder added a commit that referenced this pull request Aug 14, 2024
@schauder
Copy link
Contributor Author

Thanks for the feedback. I applied the requested changes and added them to main and 3.3.x

@schauder schauder closed this Aug 14, 2024
@schauder schauder added this to the 3.3.3 (2024.0.3) milestone Aug 14, 2024
@schauder schauder deleted the issue/1841-doc-template branch November 11, 2024 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

JDBC and R2DBC Criteria API documentation mismatch
3 participants