Skip to content

Avoid ambiguity in dataStore name requirements #1406

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.

Sign up for GitHub

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

Open
njr-11 wants to merge 2 commits into
base: main
Choose a base branch
from
+22 −11
Open

Avoid ambiguity in dataStore name requirements #1406

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c67f111
Avoid ambiguity in dataStore name requirements
njr-11 Mar 18, 2026
9ffd560
Review comment from Gavin to reverse order
njr-11 Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 22 additions & 11 deletions api/src/main/java/jakarta/data/repository/Repository.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,28 +100,39 @@
* Interoperability with Jakarta Config is reserved for future versions
* of Jakarta Data.
* </li>
* <li>If running in an environment where JNDI is available and the
* <li><p>If running in an environment where JNDI is available and the
* {@code dataStore} value has the prefix {@code java:}, the Jakarta Data
* provider attempts to look up the value as a name in JNDI. If the
* resource found in JNDI is compatible with the Jakarta Data provider
* and the entities accessed by the {@code Repository}, then the resource
* becomes the data store for the {@code Repository}. For relational
* data access, the {@code dataStore} value can be:
* becomes the data store for the {@code Repository}.</p>
*
* <p>Jakarta Data providers that access a relational database via
* Jakarta Persistence must accept the following as the {@code dataStore}
* value:
* <ul>
* <li>the JNDI name of a {@link javax.sql.DataSource},
* </li>
* <li>the name of a {@code jakarta.annotation.sql.DataSourceDefinition},
* <li>the JNDI name of a persistence unit reference</li>
* <li>the {@code jakarta.persistence.EntityManagerFactory} default
* JNDI name of the form
* {@code java:module/persistence/{unit-name}/EntityManagerFactory}
* or {@code java:app/persistence/{unit-name}/EntityManagerFactory}.
* </li>
* <li>the JNDI name of a resource reference to a {@code DataSource},
* </ul>
* </p>
* <p>Other Jakarta Data providers that access a relational database via
* JDBC must accept the following as the {@code dataStore} value:
* <ul>
* <li>the JNDI name of a {@link javax.sql.DataSource}
* </li>
* <li>the JNDI name of a {@code jakarta.peristence.EntityManagerFactory}, or
* <li>the name of a {@code jakarta.annotation.sql.DataSourceDefinition}
* </li>
* <li>the JNDI name of a persistence unit reference.
* <li>the JNDI name of a resource reference to a {@code DataSource}
* </li>
* </ul>
* </p>
* </li>
* <li>Otherwise, if the entities used by the {@code Repository} indicate
* a relational database and the {@code dataStore} value matches the name
* <li>Otherwise, if the {@code Repository} uses Jakarta Persistence
* entities and the {@code dataStore} value matches the name
* of a persistence unit, then the corresponding
* {@code jakarta.peristence.EntityManagerFactory} becomes the data store
* for the {@code Repository}. Precedence for matching a persistence unit
Expand Down