My Favorite Spring Data JPA Feature

I like Spring Data JPA. It helps simplify my codebase, and most of the time frees me up from writing JPAQL or SQL. I’m also impressed by the complexity of query you can write using Spring Data. My favourite feature is returning the first or top records from a table.

Let's say I have a table tracking document versions -

DOCUMENT_TABLE

With its associated JPA object -

@Entity
@Table(name = "DOCUMENT_TABLE")
public class Document implements Serializable {
   private static final long serialVersionUID = 1L;

   @Id
   @Column(name = "DOCUMENT_ID")
   private Long documentId;

   @Basic(optional = false)
   @NotNull
   private String name;

   @Basic(optional = false)
   @NotNull
   private Long version;

}

My SQL would be -

SELECT *
FROM
  (SELECT *
  FROM document_table dt
  WHERE dt.name = 'mydoc.doc'
  ORDER BY dt.VERSION DESC
  )
WHERE rownum = 1;

Or in JPA -

select d
   from Document d
   where d.name = :name
   and d.version = (select max(d.version) from Document d where d.name = :name)

But I want to keep my codebase consistent so the first thing I can try is -

public interface DocumentRepository extends CrudRepository<Document, Long> {
    List<Document> findByNameOrderByVersionDesc(String name);
}

I can get the first record -

List<Document> documentList =
   documentRepository.findByNameOrderByVersionDesc("mydoc.doc");
Document document = documentList.get(0);

Another alternative is to have a straight SQL query in the repository, but the best option is to use the Top feature in spring data -

public interface DocumentRepository extends CrudRepository<Document, Long> {
    Document findFirstByNameOrderByVersionDesc(String name);
    Document findTopByNameOrderByVersionDesc(String name);
}

The above methods being equivalent

We can even use Top to return the top n records -

Document findTop2ByNameOrderByVersionDesc(String name);

Interestingly, but not suprisingly, the underlying SQL generated by Spring Data opts for the rownum construct I used in my original SQL statement