simpler result mappings for @StaticNativeQuery

[gavinking]

Currently, we say you can do this:

@StaticNativeQuery("select * from books where isbn = ?")
@SqlResultSetMapping(entities =
        @EntityResult(entityClass = Book.class,
                fields = {@FieldResult(name = "isbn", column = "isbn_13"),
                          @FieldResult(name = "title", column = "title_en")}))
Book getBookWithIsbn(String isbn);

I think that's just unnecessary ceremony, when we can easily just let you write this:

@StaticNativeQuery("select * from books where isbn = ?")
@EntityResult(entityClass = Book.class,
        fields = {@FieldResult(name = "isbn", column = "isbn_13"),
                  @FieldResult(name = "title", column = "title_en")})
Book getBookWithIsbn(String isbn);

All we need to do is promote the XxxResult annotations to METHOD and make them @Repeatable.

[gavinking]

I have implemented this proposal in #968.

[hantsy]

If we allow free SQL queries here, I think the result class should not be limited to use the Entity class. Similar to select new APojo(u.id, u.username) from users u in JPQL, is it possible to support a custom record as the result type here?

[hantsy]

I am not sure whether the @StaticNativeQuery is used in an interface method or somewhere.

We have @NamedQuery and @NamedNativeQuery on the entity class. Follow the naming, I think @NativeQuery is better. And nesting the resultMapping attribute in the annotation is preferable because of its existing usage in @NamedNativeQuery.

[gavinking]

is it possible to support a custom record as the result type here?

yes, of course, that is already part of the proposal.

https://github.com/jakartaee/persistence/pull/968/changes#diff-7eeb5b3a1a224543e7ded5ed63160bf658437669068d199d1b7669756c8bfab6R84

I am not sure whether the @StaticNativeQuery is used in an interface method or somewhere.

It's explained right there in the Javadoc:

 * This annotation may be applied to:
 * <ul>
 * <li>any method of any class or interface belonging to the persistence
 *     unit, or
 * <li>a query method of a Jakarta Data repository with
 *     an implementation backed by Jakarta Persistence.
 * </ul>

Follow the naming, I think @NativeQuery is better.

It's worse, because then @StaticQuery would have to be called @Query, and we already have multiple things called Query.

And nesting the resultMapping attribute in the annotation is preferable because of its existing usage in @NamedNativeQuery.

We already decided not to not go down that path because it results in significantly uglier code.

This is nice:

@StaticNativeQuery("select * from Book")
@EntityResult(targetClass=Book.class, ... )
List<Book> books();

This is significantly less nice:

@StaticNativeQuery(sql = "select * from Book",
    resultMapping=@EntityResult(entityClass=Book.class, ... ))
List<Book> books();

[hantsy]

Personally, I like the latter.

@StaticNativeQuery(sql = "select * from Book",
    resultMapping=@EntityResult(entityClass=Book.class, ... ))
List<Book> books();

[gavinking]

OK. Can't please everyone, I guess.