Getting started with Spring Boot

The starter wires the library into Spring Data repositories. It reads modelquery.* properties into the same ModelQueryConfig you would build by hand, so nothing works only under Spring.

1. Add the dependencies

Import the BOM as shown in Getting started without Spring, then add:

<dependency>
    <groupId>io.github.rey5137</groupId>
    <artifactId>model-query-spring-boot-starter</artifactId>
</dependency>

That one dependency brings spring-boot-starter-data-jpa (Hibernate is Boot's default JPA provider), model-query-hibernate, model-query-spring-data and, through them, the executor and the annotations. Declare no other library artifact; model-query-annotations is needed only in a module that has no starter, such as a shared module holding your models.

Register model-query-processor in annotationProcessorPaths, as in the plain-JPA guide: Maven cannot add an annotation processor through a dependency, so the starter cannot bring it.

2. Extend ModelQueryRepository

ModelQueryRepository is a repository fragment: extend it next to JpaRepository or any other Spring Data interface. Its type parameter is the repository's own entity.

public interface BookRepository extends JpaRepository<BookEntity, Long>, ModelQueryRepository<BookEntity> {}

@QueryModel(root = BookEntity.class)
public record BookView(@PrimaryKey Long id, String title, Integer released) {}

3. Query

private static final ModelQuery<BookEntity, Long, BookView> BOOKS = QBookView.query()
        .select(QBookView.ALL)
        .orderBy(QBookView.TITLE.asc())
        .build();

ModelPage<BookView> page = books.findPage(BOOKS, PageRequest.of(0, 20), CountMode.COUNT);

A Pageable converts to the library's page spec, and its Sort is applied to the selected columns by property name. See Spring Data and the starter.

4. Configure

Set modelquery.* properties in application.properties when you need to override a default. For example:

modelquery.export.page-size=2000
modelquery.query-timeout=30s

The sample application

samples/spring-boot is one application over three databases (H2, PostgreSQL, MySQL). Each package holds a datasource, an EntityManagerFactory, a transaction manager and its repositories, and the starter wires every repository; each factory resolves the vendor profile of its own database. It also has a validated PATCH endpoint built on a generated change set; see Bulk writes.

The h2 package keeps its own JpaRepositoryFactoryBean subclass and repository base class, with one repository that extends ModelQueryRepository and one that does not (recipe 1). Each of the five migration recipes has an endpoint: /books/{id}/detail (recipe 1), /books/by-review and /books/with-review (recipe 2), /films/bands (recipe 3), /films/by-tickets and /films/by-tickets/keyset (recipe 4), and /songs and /songs/credits (recipe 8); see Migration recipes.