Skip to content

Avoid ambiguity in dataStore name requirements#1406

Open
njr-11 wants to merge 2 commits intojakartaee:mainfrom
njr-11:avoid-ambiguity-in-dataStore-name-requirements
Open

Avoid ambiguity in dataStore name requirements#1406
njr-11 wants to merge 2 commits intojakartaee:mainfrom
njr-11:avoid-ambiguity-in-dataStore-name-requirements

Conversation

@njr-11
Copy link
Copy Markdown
Member

@njr-11 njr-11 commented Mar 18, 2026

This was discussed on today's Jakarta Data call. Javadoc for @Repository(dataStore = ...) has some ambiguity in the requirements for relational databases that could be interpreted to mean that Jakarta Data providers that access the database via JDBC vs Jakarta Persistence might need to support all of the possible types of names/JNDI names. This PR splits the single list into 2 separate lists for better clarity. It also elaborates on what is meant by the JNDI name of an EntityManagerFactory (recently added in Jakarta Persistence) vs a persistence unit reference JNDI name, which was also mentioned during the meeting.

@njr-11 njr-11 added this to the 1.1 milestone Mar 18, 2026
@njr-11 njr-11 added the documentation Improvements or additions to documentation label Mar 18, 2026
@otaviojava otaviojava requested a review from gavinking March 19, 2026 08:27
Comment on lines +110 to +111
* <p>Jakarta Data providers that access a relational database via JDBC
* must accept the following as the {@code dataStore} value:
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I think I know what you're trying to say here, but since JPA implementations usually use JDBC to access the database, this is still slightly ambiguous.

You could maybe reverse the order of the cases and say "Other Jakarta Data providers that access a relational database via JDBC".

Copy link
Copy Markdown
Member Author

@njr-11 njr-11 Mar 19, 2026

Choose a reason for hiding this comment

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

Good idea. And we would probably rather have the JPA information show up first regardless. I added a commit to switch it.

Copy link
Copy Markdown
Member

@KyleAure KyleAure left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@KyleAure KyleAure mentioned this pull request Mar 24, 2026
21 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants