Merge pull request #48877 from marko-bekhta/doc/data-repository-nondefault-pu

Document/test how to work with non-default PUs and Jakarta Data repositories

Author: gsmet

docs/src/main/asciidoc/hibernate-orm.adoc

@@ -1796,10 +1796,10 @@ public interface MyRepository extends CrudRepository<MyEntity, Integer> { // <1>
 
 }
 ----
-1. To skip the boilerplate definition of CRUD operations,
+<1> To skip the boilerplate definition of CRUD operations,
 we can use one of the available interfaces (e.g. `CrudRepository` or `BasicRepository`).
-2. Adding custom queries with parameters is as easy as providing your query string to the `@Query` annotation.
-3. If the basic CRUD operations from the Jakarta Data interfaces are not enough,
+<2> Adding custom queries with parameters is as easy as providing your query string to the `@Query` annotation.
+<3> If the basic CRUD operations from the Jakarta Data interfaces are not enough,
 we can always add a custom one, in this case a delete operation that removes `MyEntity`s by name.
 
 And then the repository can be used as any other bean:
@@ -1817,10 +1817,28 @@ public class MyEntityResource {
         repository.insert(entity);
     }
 
-	// ...
+    // ...
+
+}
+----
+
+[NOTE]
+====
+When working with non-default persistence units, remember to specify the persistence unit name the repository is targeting
+in the `dataStore` attribute of the repository annotation:
 
+[source,java]
+----
+@Repository(dataStore = "other") // <1>
+public interface MyNonDefaultPURepository {
+    // ...
 }
 ----
+<1> Pass the name of the non-default persistence unit to the repository annotation (`other` in this example).
+
+Review the https://jakarta.ee/specifications/data/1.0/apidocs/jakarta.data/jakarta/data/repository/repository#dataStore()[Javadoc of the `@Repository` annotation]
+to learn more about the `dataStore` attribute.
+====
 
 Please refer to the corresponding https://hibernate.org/repositories/[Hibernate Data Repositories]
 and https://jakarta.ee/specifications/data/1.0/jakarta-data-1.0[Jakarta Data]

integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/jpamodelgen/data/MyEntityResource.java renamed to integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/processor/data/MyEntityResource.java

@@ -1,4 +1,4 @@
-package io.quarkus.it.hibernate.jpamodelgen.data;
+package io.quarkus.it.hibernate.processor.data;
 
 import java.util.List;
 
@@ -17,6 +17,10 @@
 
 import org.jboss.resteasy.reactive.RestPath;
 
+import io.quarkus.it.hibernate.processor.data.pudefault.MyEntity;
+import io.quarkus.it.hibernate.processor.data.pudefault.MyEntity_;
+import io.quarkus.it.hibernate.processor.data.pudefault.MyRepository;
+
 @ApplicationScoped
 @Produces("application/json")
 @Consumes("application/json")

integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/processor/data/MyOtherEntityResource.java

@@ -0,0 +1,70 @@
+package io.quarkus.it.hibernate.processor.data;
+
+import java.util.List;
+
+import jakarta.data.Order;
+import jakarta.data.Sort;
+import jakarta.enterprise.context.ApplicationScoped;
+import jakarta.inject.Inject;
+import jakarta.transaction.Transactional;
+import jakarta.ws.rs.Consumes;
+import jakarta.ws.rs.DELETE;
+import jakarta.ws.rs.GET;
+import jakarta.ws.rs.NotFoundException;
+import jakarta.ws.rs.POST;
+import jakarta.ws.rs.Path;
+import jakarta.ws.rs.Produces;
+
+import org.jboss.resteasy.reactive.RestPath;
+
+import io.quarkus.it.hibernate.processor.data.puother.MyOtherEntity;
+import io.quarkus.it.hibernate.processor.data.puother.MyOtherEntity_;
+import io.quarkus.it.hibernate.processor.data.puother.MyOtherRepository;
+
+@ApplicationScoped
+@Produces("application/json")
+@Consumes("application/json")
+@Path("/data/other")
+public class MyOtherEntityResource {
+
+    @Inject
+    MyOtherRepository repository;
+
+    @POST
+    @Transactional
+    public void create(MyOtherEntity entity) {
+        repository.insert(entity);
+    }
+
+    @GET
+    public List<MyOtherEntity> get() {
+        return repository.findAll(Order.by(Sort.asc(MyOtherEntity_.NAME))).toList();
+    }
+
+    @GET
+    @Transactional
+    @Path("/by/name/{name}")
+    public MyOtherEntity getByName(@RestPath String name) {
+        List<MyOtherEntity> entities = repository.findByName(name);
+        if (entities.isEmpty()) {
+            throw new NotFoundException();
+        }
+        return entities.get(0);
+    }
+
+    @POST
+    @Transactional
+    @Path("/rename/{before}/to/{after}")
+    public void rename(@RestPath String before, @RestPath String after) {
+        MyOtherEntity byName = getByName(before);
+        byName.name = after;
+        repository.update(byName);
+    }
+
+    @DELETE
+    @Transactional
+    @Path("/by/name/{name}")
+    public void deleteByName(@RestPath String name) {
+        repository.delete(name);
+    }
+}

integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/jpamodelgen/data/MyEntity.java renamed to integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/processor/data/pudefault/MyEntity.java

@@ -1,4 +1,4 @@
-package io.quarkus.it.hibernate.jpamodelgen.data;
+package io.quarkus.it.hibernate.processor.data.pudefault;
 
 import jakarta.persistence.Column;
 import jakarta.persistence.Entity;

integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/jpamodelgen/data/MyRepository.java renamed to integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/processor/data/pudefault/MyRepository.java

@@ -1,4 +1,4 @@
-package io.quarkus.it.hibernate.jpamodelgen.data;
+package io.quarkus.it.hibernate.processor.data.pudefault;
 
 import java.util.List;
 import java.util.stream.Stream;

integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/processor/data/puother/MyOtherEntity.java

@@ -0,0 +1,30 @@
+package io.quarkus.it.hibernate.processor.data.puother;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.Id;
+
+@Entity
+public class MyOtherEntity {
+
+    @Id
+    @GeneratedValue
+    public Integer id;
+
+    @Column(unique = true)
+    public String name;
+
+    MyOtherEntity() {
+    }
+
+    public MyOtherEntity(String name) {
+        this.name = name;
+    }
+
+    @Override
+    public String toString() {
+        return "MyOrmEntity [id=" + id + ", name=" + name + "]";
+    }
+
+}

integration-tests/hibernate-orm-data/src/main/java/io/quarkus/it/hibernate/processor/data/puother/MyOtherRepository.java

@@ -0,0 +1,25 @@
+package io.quarkus.it.hibernate.processor.data.puother;
+
+import java.util.List;
+import java.util.stream.Stream;
+
+import jakarta.data.Order;
+import jakarta.data.repository.CrudRepository;
+import jakarta.data.repository.Delete;
+import jakarta.data.repository.Find;
+import jakarta.data.repository.Query;
+import jakarta.data.repository.Repository;
+
+@Repository(dataStore = "other")
+public interface MyOtherRepository extends CrudRepository<MyOtherEntity, Integer> {
+
+    @Find
+    Stream<MyOtherEntity> findAll(Order<MyOtherEntity> order);
+
+    @Query("select e from MyOtherEntity e where e.name like :name")
+    List<MyOtherEntity> findByName(String name);
+
+    @Delete
+    void delete(String name);
+
+}

integration-tests/hibernate-orm-data/src/main/resources/application.properties

@@ -1,2 +1,9 @@
 quarkus.datasource.jdbc.max-size=8
-quarkus.hibernate-orm.database.generation=drop-and-create
+quarkus.hibernate-orm.packages=io.quarkus.it.hibernate.processor.data.pudefault
+quarkus.hibernate-orm.schema-management.strategy=drop-and-create
+quarkus.hibernate-orm.schema-management.create-schemas=true
+# Define non-default PU so that we can configure a custom JSON format mapper. The default PU is using the default mapper.
+quarkus.hibernate-orm."other".datasource=<default>
+quarkus.hibernate-orm."other".packages=io.quarkus.it.hibernate.processor.data.puother
+quarkus.hibernate-orm."other".schema-management.strategy=drop-and-create
+quarkus.hibernate-orm."other".schema-management.create-schemas=true

integration-tests/hibernate-orm-data/src/test/java/io/quarkus/it/hibernate/jpamodelgen/data/HibernateOrmDataInGraalIT.java renamed to integration-tests/hibernate-orm-data/src/test/java/io/quarkus/it/hibernate/processor/data/HibernateOrmDataInGraalIT.java

@@ -1,4 +1,4 @@
-package io.quarkus.it.hibernate.jpamodelgen.data;
+package io.quarkus.it.hibernate.processor.data;
 
 import io.quarkus.test.junit.QuarkusIntegrationTest;
 

integration-tests/hibernate-orm-data/src/test/java/io/quarkus/it/hibernate/jpamodelgen/data/HibernateOrmDataTest.java renamed to integration-tests/hibernate-orm-data/src/test/java/io/quarkus/it/hibernate/processor/data/HibernateOrmDataTest.java

@@ -1,48 +1,50 @@
-package io.quarkus.it.hibernate.jpamodelgen.data;
+package io.quarkus.it.hibernate.processor.data;
 
 import static io.restassured.RestAssured.given;
 import static org.hamcrest.CoreMatchers.containsString;
 import static org.hamcrest.CoreMatchers.equalTo;
 
-import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.ValueSource;
 
+import io.quarkus.it.hibernate.processor.data.pudefault.MyEntity;
 import io.quarkus.test.junit.QuarkusTest;
 import io.restassured.http.ContentType;
 
 @QuarkusTest
 public class HibernateOrmDataTest {
-    private static final String ROOT = "/data";
 
-    @Test
-    public void staticMetamodel() {
+    @ValueSource(strings = { "/data", "/data/other" })
+    @ParameterizedTest
+    public void repositoryDefaultPu(String root) {
         // Create/retrieve
         given()
                 .pathParam("name", "foo")
                 .contentType(ContentType.JSON)
-                .when().get(ROOT + "/by/name/{name}")
+                .when().get(root + "/by/name/{name}")
                 .then()
                 .statusCode(404);
         given()
                 .contentType(ContentType.JSON)
-                .when().get(ROOT)
+                .when().get(root)
                 .then()
                 .statusCode(200)
                 .body(equalTo("[]"));
         given()
                 .body(new MyEntity("foo"))
                 .contentType(ContentType.JSON)
-                .when().post(ROOT)
+                .when().post(root)
                 .then()
                 .statusCode(204);
         given()
                 .pathParam("name", "foo")
                 .contentType(ContentType.JSON)
-                .when().get(ROOT + "/by/name/{name}")
+                .when().get(root + "/by/name/{name}")
                 .then()
                 .statusCode(200);
         given()
                 .contentType(ContentType.JSON)
-                .when().get(ROOT)
+                .when().get(root)
                 .then()
                 .statusCode(200)
                 .body(containsString("\"foo\""));
@@ -51,34 +53,34 @@ public void staticMetamodel() {
         given()
                 .pathParam("name", "bar")
                 .contentType(ContentType.JSON)
-                .when().get(ROOT + "/by/name/{name}")
+                .when().get(root + "/by/name/{name}")
                 .then()
                 .statusCode(404);
         given()
                 .pathParam("before", "foo")
                 .pathParam("after", "bar")
                 .contentType(ContentType.JSON)
-                .when().post(ROOT + "/rename/{before}/to/{after}")
+                .when().post(root + "/rename/{before}/to/{after}")
                 .then()
                 .statusCode(204);
         given()
                 .pathParam("name", "bar")
                 .contentType(ContentType.JSON)
-                .when().get(ROOT + "/by/name/{name}")
+                .when().get(root + "/by/name/{name}")
                 .then()
                 .statusCode(200);
 
         // Delete
         given()
                 .pathParam("name", "bar")
                 .contentType(ContentType.JSON)
-                .when().delete(ROOT + "/by/name/{name}")
+                .when().delete(root + "/by/name/{name}")
                 .then()
                 .statusCode(204);
         given()
                 .pathParam("name", "bar")
                 .contentType(ContentType.JSON)
-                .when().get(ROOT + "/by/name/{name}")
+                .when().get(root + "/by/name/{name}")
                 .then()
                 .statusCode(404);
     }